]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/dma/dw/regs.h
dmaengine: dw: revisit data_width property
[mirror_ubuntu-bionic-kernel.git] / drivers / dma / dw / regs.h
CommitLineData
3bfb1d20
HS
1/*
2 * Driver for the Synopsys DesignWare AHB DMA Controller
3 *
4 * Copyright (C) 2005-2007 Atmel Corporation
aecb7b64 5 * Copyright (C) 2010-2011 ST Microelectronics
3bfb1d20
HS
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 */
11
9cade1a4 12#include <linux/interrupt.h>
0fdb567f 13#include <linux/dmaengine.h>
3bfb1d20
HS
14
15#define DW_DMA_MAX_NR_CHANNELS 8
f9c6a655 16#define DW_DMA_MAX_NR_REQUESTS 16
3bfb1d20 17
a1c46016
VK
18/* flow controller */
19enum dw_dma_fc {
20 DW_DMA_FC_D_M2M,
21 DW_DMA_FC_D_M2P,
22 DW_DMA_FC_D_P2M,
23 DW_DMA_FC_D_P2P,
24 DW_DMA_FC_P_P2M,
25 DW_DMA_FC_SP_P2P,
26 DW_DMA_FC_P_M2P,
27 DW_DMA_FC_DP_P2P,
28};
29
3bfb1d20
HS
30/*
31 * Redefine this macro to handle differences between 32- and 64-bit
32 * addressing, big vs. little endian, etc.
33 */
34#define DW_REG(name) u32 name; u32 __pad_##name
35
36/* Hardware register definitions. */
37struct dw_dma_chan_regs {
38 DW_REG(SAR); /* Source Address Register */
39 DW_REG(DAR); /* Destination Address Register */
40 DW_REG(LLP); /* Linked List Pointer */
41 u32 CTL_LO; /* Control Register Low */
42 u32 CTL_HI; /* Control Register High */
43 DW_REG(SSTAT);
44 DW_REG(DSTAT);
45 DW_REG(SSTATAR);
46 DW_REG(DSTATAR);
47 u32 CFG_LO; /* Configuration Register Low */
48 u32 CFG_HI; /* Configuration Register High */
49 DW_REG(SGR);
50 DW_REG(DSR);
51};
52
53struct dw_dma_irq_regs {
54 DW_REG(XFER);
55 DW_REG(BLOCK);
56 DW_REG(SRC_TRAN);
57 DW_REG(DST_TRAN);
58 DW_REG(ERROR);
59};
60
61struct dw_dma_regs {
62 /* per-channel registers */
63 struct dw_dma_chan_regs CHAN[DW_DMA_MAX_NR_CHANNELS];
64
65 /* irq handling */
66 struct dw_dma_irq_regs RAW; /* r */
67 struct dw_dma_irq_regs STATUS; /* r (raw & mask) */
68 struct dw_dma_irq_regs MASK; /* rw (set = irq enabled) */
69 struct dw_dma_irq_regs CLEAR; /* w (ack, affects "raw") */
70
71 DW_REG(STATUS_INT); /* r */
72
73 /* software handshaking */
74 DW_REG(REQ_SRC);
75 DW_REG(REQ_DST);
76 DW_REG(SGL_REQ_SRC);
77 DW_REG(SGL_REQ_DST);
78 DW_REG(LAST_SRC);
79 DW_REG(LAST_DST);
80
81 /* miscellaneous */
82 DW_REG(CFG);
83 DW_REG(CH_EN);
84 DW_REG(ID);
85 DW_REG(TEST);
86
2a9fe9ae
AS
87 /* reserved */
88 DW_REG(__reserved0);
89 DW_REG(__reserved1);
90
745664eb 91 /* optional encoded params, 0x3c8..0x3f7 */
2a9fe9ae
AS
92 u32 __reserved;
93
94 /* per-channel configuration registers */
95 u32 DWC_PARAMS[DW_DMA_MAX_NR_CHANNELS];
96 u32 MULTI_BLK_TYPE;
97 u32 MAX_BLK_SIZE;
98
99 /* top-level parameters */
100 u32 DW_PARAMS;
3bfb1d20
HS
101};
102
e368b510
VK
103/*
104 * Big endian I/O access when reading and writing to the DMA controller
105 * registers. This is needed on some platforms, like the Atmel AVR32
106 * architecture.
107 */
108
d5ea7b5e
HT
109#ifdef CONFIG_DW_DMAC_BIG_ENDIAN_IO
110#define dma_readl_native ioread32be
111#define dma_writel_native iowrite32be
112#else
113#define dma_readl_native readl
114#define dma_writel_native writel
115#endif
116
2a9fe9ae
AS
117/* Bitfields in DW_PARAMS */
118#define DW_PARAMS_NR_CHAN 8 /* number of channels */
119#define DW_PARAMS_NR_MASTER 11 /* number of AHB masters */
120#define DW_PARAMS_DATA_WIDTH(n) (15 + 2 * (n))
121#define DW_PARAMS_DATA_WIDTH1 15 /* master 1 data width */
122#define DW_PARAMS_DATA_WIDTH2 17 /* master 2 data width */
123#define DW_PARAMS_DATA_WIDTH3 19 /* master 3 data width */
124#define DW_PARAMS_DATA_WIDTH4 21 /* master 4 data width */
125#define DW_PARAMS_EN 28 /* encoded parameters */
126
127/* Bitfields in DWC_PARAMS */
128#define DWC_PARAMS_MBLK_EN 11 /* multi block transfer */
129
46e8c83c
AS
130/* bursts size */
131enum dw_dma_msize {
132 DW_DMA_MSIZE_1,
133 DW_DMA_MSIZE_4,
134 DW_DMA_MSIZE_8,
135 DW_DMA_MSIZE_16,
136 DW_DMA_MSIZE_32,
137 DW_DMA_MSIZE_64,
138 DW_DMA_MSIZE_128,
139 DW_DMA_MSIZE_256,
140};
141
2a0fae02
MR
142/* Bitfields in LLP */
143#define DWC_LLP_LMS(x) ((x) & 3) /* list master select */
144#define DWC_LLP_LOC(x) ((x) & ~3) /* next lli */
145
3bfb1d20
HS
146/* Bitfields in CTL_LO */
147#define DWC_CTLL_INT_EN (1 << 0) /* irqs enabled? */
148#define DWC_CTLL_DST_WIDTH(n) ((n)<<1) /* bytes per element */
149#define DWC_CTLL_SRC_WIDTH(n) ((n)<<4)
150#define DWC_CTLL_DST_INC (0<<7) /* DAR update/not */
151#define DWC_CTLL_DST_DEC (1<<7)
152#define DWC_CTLL_DST_FIX (2<<7)
c9784a46 153#define DWC_CTLL_SRC_INC (0<<9) /* SAR update/not */
3bfb1d20
HS
154#define DWC_CTLL_SRC_DEC (1<<9)
155#define DWC_CTLL_SRC_FIX (2<<9)
156#define DWC_CTLL_DST_MSIZE(n) ((n)<<11) /* burst, #elements */
157#define DWC_CTLL_SRC_MSIZE(n) ((n)<<14)
158#define DWC_CTLL_S_GATH_EN (1 << 17) /* src gather, !FIX */
159#define DWC_CTLL_D_SCAT_EN (1 << 18) /* dst scatter, !FIX */
ee66509d 160#define DWC_CTLL_FC(n) ((n) << 20)
3bfb1d20
HS
161#define DWC_CTLL_FC_M2M (0 << 20) /* mem-to-mem */
162#define DWC_CTLL_FC_M2P (1 << 20) /* mem-to-periph */
163#define DWC_CTLL_FC_P2M (2 << 20) /* periph-to-mem */
164#define DWC_CTLL_FC_P2P (3 << 20) /* periph-to-periph */
165/* plus 4 transfer types for peripheral-as-flow-controller */
166#define DWC_CTLL_DMS(n) ((n)<<23) /* dst master select */
167#define DWC_CTLL_SMS(n) ((n)<<25) /* src master select */
168#define DWC_CTLL_LLP_D_EN (1 << 27) /* dest block chain */
169#define DWC_CTLL_LLP_S_EN (1 << 28) /* src block chain */
170
171/* Bitfields in CTL_HI */
172#define DWC_CTLH_DONE 0x00001000
173#define DWC_CTLH_BLOCK_TS_MASK 0x00000fff
174
46e8c83c 175/* Bitfields in CFG_LO */
93317e8e
VK
176#define DWC_CFGL_CH_PRIOR_MASK (0x7 << 5) /* priority mask */
177#define DWC_CFGL_CH_PRIOR(x) ((x) << 5) /* priority */
3bfb1d20
HS
178#define DWC_CFGL_CH_SUSP (1 << 8) /* pause xfer */
179#define DWC_CFGL_FIFO_EMPTY (1 << 9) /* pause xfer */
180#define DWC_CFGL_HS_DST (1 << 10) /* handshake w/dst */
181#define DWC_CFGL_HS_SRC (1 << 11) /* handshake w/src */
46e8c83c
AS
182#define DWC_CFGL_LOCK_CH_XFER (0 << 12) /* scope of LOCK_CH */
183#define DWC_CFGL_LOCK_CH_BLOCK (1 << 12)
184#define DWC_CFGL_LOCK_CH_XACT (2 << 12)
185#define DWC_CFGL_LOCK_BUS_XFER (0 << 14) /* scope of LOCK_BUS */
186#define DWC_CFGL_LOCK_BUS_BLOCK (1 << 14)
187#define DWC_CFGL_LOCK_BUS_XACT (2 << 14)
188#define DWC_CFGL_LOCK_CH (1 << 15) /* channel lockout */
189#define DWC_CFGL_LOCK_BUS (1 << 16) /* busmaster lockout */
190#define DWC_CFGL_HS_DST_POL (1 << 18) /* dst handshake active low */
191#define DWC_CFGL_HS_SRC_POL (1 << 19) /* src handshake active low */
3bfb1d20
HS
192#define DWC_CFGL_MAX_BURST(x) ((x) << 20)
193#define DWC_CFGL_RELOAD_SAR (1 << 30)
194#define DWC_CFGL_RELOAD_DAR (1 << 31)
195
46e8c83c
AS
196/* Bitfields in CFG_HI */
197#define DWC_CFGH_FCMODE (1 << 0)
198#define DWC_CFGH_FIFO_MODE (1 << 1)
199#define DWC_CFGH_PROTCTL(x) ((x) << 2)
3bfb1d20
HS
200#define DWC_CFGH_DS_UPD_EN (1 << 5)
201#define DWC_CFGH_SS_UPD_EN (1 << 6)
46e8c83c
AS
202#define DWC_CFGH_SRC_PER(x) ((x) << 7)
203#define DWC_CFGH_DST_PER(x) ((x) << 11)
3bfb1d20
HS
204
205/* Bitfields in SGR */
206#define DWC_SGR_SGI(x) ((x) << 0)
207#define DWC_SGR_SGC(x) ((x) << 20)
208
209/* Bitfields in DSR */
210#define DWC_DSR_DSI(x) ((x) << 0)
211#define DWC_DSR_DSC(x) ((x) << 20)
212
213/* Bitfields in CFG */
214#define DW_CFG_DMA_EN (1 << 0)
215
d9de4519
HCE
216enum dw_dmac_flags {
217 DW_DMA_IS_CYCLIC = 0,
fed2574b 218 DW_DMA_IS_SOFT_LLP = 1,
5e09f98e 219 DW_DMA_IS_PAUSED = 2,
423f9cbf 220 DW_DMA_IS_INITIALIZED = 3,
d9de4519
HCE
221};
222
3bfb1d20 223struct dw_dma_chan {
0fdb567f
AS
224 struct dma_chan chan;
225 void __iomem *ch_regs;
226 u8 mask;
227 u8 priority;
228 enum dma_transfer_direction direction;
3bfb1d20 229
fed2574b 230 /* software emulation of the LLP transfers */
fed2574b
AS
231 struct list_head *tx_node_active;
232
3bfb1d20
HS
233 spinlock_t lock;
234
235 /* these other elements are all protected by lock */
d9de4519 236 unsigned long flags;
3bfb1d20
HS
237 struct list_head active_list;
238 struct list_head queue;
d9de4519 239 struct dw_cyclic_desc *cdesc;
3bfb1d20 240
3bfb1d20 241 unsigned int descs_allocated;
327e6970 242
4a63a8b3
AS
243 /* hardware configuration */
244 unsigned int block_size;
fed2574b 245 bool nollp;
f776076b
AB
246
247 /* custom slave configuration */
89500520
AS
248 u8 src_id;
249 u8 dst_id;
c422025c
AS
250 u8 m_master;
251 u8 p_master;
4a63a8b3 252
295d3e10 253 /* configuration passed via .device_config */
327e6970 254 struct dma_slave_config dma_sconfig;
3bfb1d20
HS
255};
256
257static inline struct dw_dma_chan_regs __iomem *
258__dwc_regs(struct dw_dma_chan *dwc)
259{
260 return dwc->ch_regs;
261}
262
263#define channel_readl(dwc, name) \
d5ea7b5e 264 dma_readl_native(&(__dwc_regs(dwc)->name))
3bfb1d20 265#define channel_writel(dwc, name, val) \
d5ea7b5e 266 dma_writel_native((val), &(__dwc_regs(dwc)->name))
3bfb1d20
HS
267
268static inline struct dw_dma_chan *to_dw_dma_chan(struct dma_chan *chan)
269{
270 return container_of(chan, struct dw_dma_chan, chan);
271}
272
3bfb1d20
HS
273struct dw_dma {
274 struct dma_device dma;
275 void __iomem *regs;
f8122a82 276 struct dma_pool *desc_pool;
3bfb1d20 277 struct tasklet_struct tasklet;
3bfb1d20 278
000871ce
AS
279 /* channels */
280 struct dw_dma_chan *chan;
3bfb1d20 281 u8 all_chan_mask;
99d9bf4e 282 u8 in_use;
3bfb1d20 283
a0982004
AS
284 /* hardware configuration */
285 unsigned char nr_masters;
d8ded50f 286 unsigned char data_width[DW_DMA_MAX_NR_MASTERS];
3bfb1d20
HS
287};
288
289static inline struct dw_dma_regs __iomem *__dw_regs(struct dw_dma *dw)
290{
291 return dw->regs;
292}
293
294#define dma_readl(dw, name) \
d5ea7b5e 295 dma_readl_native(&(__dw_regs(dw)->name))
3bfb1d20 296#define dma_writel(dw, name, val) \
d5ea7b5e 297 dma_writel_native((val), &(__dw_regs(dw)->name))
3bfb1d20
HS
298
299#define channel_set_bit(dw, reg, mask) \
300 dma_writel(dw, reg, ((mask) << 8) | (mask))
301#define channel_clear_bit(dw, reg, mask) \
302 dma_writel(dw, reg, ((mask) << 8) | 0)
303
304static inline struct dw_dma *to_dw_dma(struct dma_device *ddev)
305{
306 return container_of(ddev, struct dw_dma, dma);
307}
308
df1f3a23
MR
309#ifdef CONFIG_DW_DMAC_BIG_ENDIAN_IO
310typedef __be32 __dw32;
311#else
312typedef __le32 __dw32;
313#endif
314
3bfb1d20
HS
315/* LLI == Linked List Item; a.k.a. DMA block descriptor */
316struct dw_lli {
317 /* values that are not changed by hardware */
df1f3a23
MR
318 __dw32 sar;
319 __dw32 dar;
320 __dw32 llp; /* chain to next lli */
321 __dw32 ctllo;
3bfb1d20 322 /* values that may get written back: */
df1f3a23 323 __dw32 ctlhi;
3bfb1d20
HS
324 /* sstat and dstat can snapshot peripheral register state.
325 * silicon config may discard either or both...
326 */
df1f3a23
MR
327 __dw32 sstat;
328 __dw32 dstat;
3bfb1d20
HS
329};
330
331struct dw_desc {
332 /* FIRST values the hardware uses */
333 struct dw_lli lli;
334
df1f3a23
MR
335#ifdef CONFIG_DW_DMAC_BIG_ENDIAN_IO
336#define lli_set(d, reg, v) ((d)->lli.reg |= cpu_to_be32(v))
337#define lli_clear(d, reg, v) ((d)->lli.reg &= ~cpu_to_be32(v))
338#define lli_read(d, reg) be32_to_cpu((d)->lli.reg)
339#define lli_write(d, reg, v) ((d)->lli.reg = cpu_to_be32(v))
340#else
341#define lli_set(d, reg, v) ((d)->lli.reg |= cpu_to_le32(v))
342#define lli_clear(d, reg, v) ((d)->lli.reg &= ~cpu_to_le32(v))
343#define lli_read(d, reg) le32_to_cpu((d)->lli.reg)
344#define lli_write(d, reg, v) ((d)->lli.reg = cpu_to_le32(v))
345#endif
346
3bfb1d20
HS
347 /* THEN values for driver housekeeping */
348 struct list_head desc_node;
e0bd0f8c 349 struct list_head tx_list;
3bfb1d20
HS
350 struct dma_async_tx_descriptor txd;
351 size_t len;
30d38a32 352 size_t total_len;
b68fd097 353 u32 residue;
3bfb1d20
HS
354};
355
e63a47a3
AS
356#define to_dw_desc(h) list_entry(h, struct dw_desc, desc_node)
357
3bfb1d20
HS
358static inline struct dw_desc *
359txd_to_dw_desc(struct dma_async_tx_descriptor *txd)
360{
361 return container_of(txd, struct dw_desc, txd);
362}