aboutsummaryrefslogtreecommitdiff
path: root/include/libopencm3/stm32/f1/dma.h
blob: b08803f74e1aa003c46a71d7b64ab50e781306b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
/** @defgroup STM32F1xx_dma_defines DMA Defines

@ingroup STM32F1xx_defines

@brief Defined Constants and Types for the STM32F1xx DMA Controller

@version 1.0.0

@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>

@date 18 August 2012

LGPL License Terms @ref lgpl_license
 */
/*
 * This file is part of the libopencm3 project.
 *
 * Copyright (C) 2010 Thomas Otto <tommi@viadmin.org>
 * Copyright (C) 2012 Piotr Esden-Tempski <piotr@esden.net>
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

/**@{*/

#ifndef LIBOPENCM3_DMA_H
#define LIBOPENCM3_DMA_H

#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/cm3/common.h>

/* --- Convenience macros -------------------------------------------------- */

/* DMA register base adresses (for convenience) */
#define DMA1				DMA1_BASE
#define DMA2				DMA2_BASE

/* --- DMA registers ------------------------------------------------------- */

/* DMA interrupt status register (DMAx_ISR) */
#define DMA_ISR(dma_base)		MMIO32(dma_base + 0x00)
#define DMA1_ISR			DMA_ISR(DMA1)
#define DMA2_ISR			DMA_ISR(DMA2)

/* DMA interrupt flag clear register (DMAx_IFCR) */
#define DMA_IFCR(dma_base)		MMIO32(dma_base + 0x04)
#define DMA1_IFCR			DMA_IFCR(DMA1)
#define DMA2_IFCR			DMA_IFCR(DMA2)

/* DMA channel configuration register (DMAx_CCRy) */
#define DMA_CCR(dma_base, channel)	MMIO32(dma_base + 0x08 + \
					       (0x14 * ((channel) - 1)))

#define DMA1_CCR(channel)		DMA_CCR(DMA1, channel)
#define DMA1_CCR1			DMA1_CCR(DMA_CHANNEL1)
#define DMA1_CCR2			DMA1_CCR(DMA_CHANNEL2)
#define DMA1_CCR3			DMA1_CCR(DMA_CHANNEL3)
#define DMA1_CCR4			DMA1_CCR(DMA_CHANNEL4)
#define DMA1_CCR5			DMA1_CCR(DMA_CHANNEL5)
#define DMA1_CCR6			DMA1_CCR(DMA_CHANNEL6)
#define DMA1_CCR7			DMA1_CCR(DMA_CHANNEL7)

#define DMA2_CCR(channel)		DMA_CCR(DMA2, channel)
#define DMA2_CCR1			DMA2_CCR(DMA_CHANNEL1)
#define DMA2_CCR2			DMA2_CCR(DMA_CHANNEL2)
#define DMA2_CCR3			DMA2_CCR(DMA_CHANNEL3)
#define DMA2_CCR4			DMA2_CCR(DMA_CHANNEL4)
#define DMA2_CCR5			DMA2_CCR(DMA_CHANNEL5)

/* DMA number of data register (DMAx_CNDTRy) */
#define DMA_CNDTR(dma_base, channel)	MMIO32(dma_base + 0x0C + \
					       (0x14 * ((channel) - 1)))

#define DMA1_CNDTR(channel)		DMA_CNDTR(DMA1, channel)
#define DMA1_CNDTR1			DMA1_CNDTR(DMA_CHANNEL1)
#define DMA1_CNDTR2			DMA1_CNDTR(DMA_CHANNEL2)
#define DMA1_CNDTR3			DMA1_CNDTR(DMA_CHANNEL3)
#define DMA1_CNDTR4			DMA1_CNDTR(DMA_CHANNEL4)
#define DMA1_CNDTR5			DMA1_CNDTR(DMA_CHANNEL5)
#define DMA1_CNDTR6			DMA1_CNDTR(DMA_CHANNEL6)
#define DMA1_CNDTR7			DMA1_CNDTR(DMA_CHANNEL7)

#define DMA2_CNDTR(channel)		DMA_CNDTR(DMA2, channel)
#define DMA2_CNDTR1			DMA2_CNDTR(DMA_CHANNEL1)
#define DMA2_CNDTR2			DMA2_CNDTR(DMA_CHANNEL2)
#define DMA2_CNDTR3			DMA2_CNDTR(DMA_CHANNEL3)
#define DMA2_CNDTR4			DMA2_CNDTR(DMA_CHANNEL4)
#define DMA2_CNDTR5			DMA2_CNDTR(DMA_CHANNEL5)

/* DMA peripheral address register (DMAx_CPARy) */
#define DMA_CPAR(dma_base, channel)	MMIO32(dma_base + 0x10 + \
					       (0x14 * ((channel) - 1)))

#define DMA1_CPAR(channel)		DMA_CPAR(DMA1, channel)
#define DMA1_CPAR1			DMA1_CPAR(DMA_CHANNEL1)
#define DMA1_CPAR2			DMA1_CPAR(DMA_CHANNEL2)
#define DMA1_CPAR3			DMA1_CPAR(DMA_CHANNEL3)
#define DMA1_CPAR4			DMA1_CPAR(DMA_CHANNEL4)
#define DMA1_CPAR5			DMA1_CPAR(DMA_CHANNEL5)
#define DMA1_CPAR6			DMA1_CPAR(DMA_CHANNEL6)
#define DMA1_CPAR7			DMA1_CPAR(DMA_CHANNEL7)

#define DMA2_CPAR(channel)		DMA_CPAR(DMA2, channel)
#define DMA2_CPAR1			DMA2_CPAR(DMA_CHANNEL1)
#define DMA2_CPAR2			DMA2_CPAR(DMA_CHANNEL2)
#define DMA2_CPAR3			DMA2_CPAR(DMA_CHANNEL3)
#define DMA2_CPAR4			DMA2_CPAR(DMA_CHANNEL4)
#define DMA2_CPAR5			DMA2_CPAR(DMA_CHANNEL5)

/* DMA memory address register (DMAx_CMARy) */

#define DMA_CMAR(dma_base, channel)	MMIO32(dma_base + 0x14 + \
					       (0x14 * ((channel) - 1)))

#define DMA1_CMAR(channel)		DMA_CMAR(DMA1, channel)
#define DMA1_CMAR1			DMA1_CMAR(DMA_CHANNEL1)
#define DMA1_CMAR2			DMA1_CMAR(DMA_CHANNEL2)
#define DMA1_CMAR3			DMA1_CMAR(DMA_CHANNEL3)
#define DMA1_CMAR4			DMA1_CMAR(DMA_CHANNEL4)
#define DMA1_CMAR5			DMA1_CMAR(DMA_CHANNEL5)
#define DMA1_CMAR6			DMA1_CMAR(DMA_CHANNEL6)
#define DMA1_CMAR7			DMA1_CMAR(DMA_CHANNEL7)

#define DMA2_CMAR(channel)		DMA_CMAR(DMA2, channel)
#define DMA2_CMAR1			DMA2_CMAR(DMA_CHANNEL1)
#define DMA2_CMAR2			DMA2_CMAR(DMA_CHANNEL2)
#define DMA2_CMAR3			DMA2_CMAR(DMA_CHANNEL3)
#define DMA2_CMAR4			DMA2_CMAR(DMA_CHANNEL4)
#define DMA2_CMAR5			DMA2_CMAR(DMA_CHANNEL5)

/* --- DMA_ISR values ------------------------------------------------------ */

/* TEIF: Transfer error interrupt flag */
#define DMA_ISR_TEIF_BIT       		(1 << 3)
#define DMA_ISR_TEIF(channel)		(DMA_ISR_TEIF_BIT << (4 * ((channel) -1)))

#define DMA_ISR_TEIF1			DMA_ISR_TEIF(DMA_CHANNEL1)
#define DMA_ISR_TEIF2			DMA_ISR_TEIF(DMA_CHANNEL2)
#define DMA_ISR_TEIF3			DMA_ISR_TEIF(DMA_CHANNEL3)
#define DMA_ISR_TEIF4			DMA_ISR_TEIF(DMA_CHANNEL4)
#define DMA_ISR_TEIF5			DMA_ISR_TEIF(DMA_CHANNEL5)
#define DMA_ISR_TEIF6			DMA_ISR_TEIF(DMA_CHANNEL6)
#define DMA_ISR_TEIF7			DMA_ISR_TEIF(DMA_CHANNEL7)

/* HTIF: Half transfer interrupt flag */
#define DMA_ISR_HTIF_BIT       		(1 << 2)
#define DMA_ISR_HTIF(channel)		(DMA_ISR_HTIF_BIT << (4 * ((channel) -1)))

#define DMA_ISR_HTIF1			DMA_ISR_HTIF(DMA_CHANNEL1)
#define DMA_ISR_HTIF2			DMA_ISR_HTIF(DMA_CHANNEL2)
#define DMA_ISR_HTIF3			DMA_ISR_HTIF(DMA_CHANNEL3)
#define DMA_ISR_HTIF4			DMA_ISR_HTIF(DMA_CHANNEL4)
#define DMA_ISR_HTIF5			DMA_ISR_HTIF(DMA_CHANNEL5)
#define DMA_ISR_HTIF6			DMA_ISR_HTIF(DMA_CHANNEL6)
#define DMA_ISR_HTIF7			DMA_ISR_HTIF(DMA_CHANNEL7)

/* TCIF: Transfer complete interrupt flag */
#define DMA_ISR_TCIF_BIT       		(1 << 1)
#define DMA_ISR_TCIF(channel)		(DMA_ISR_TCIF_BIT << (4 * ((channel) -1)))

#define DMA_ISR_TCIF1			DMA_ISR_TCIF(DMA_CHANNEL1)
#define DMA_ISR_TCIF2			DMA_ISR_TCIF(DMA_CHANNEL2)
#define DMA_ISR_TCIF3			DMA_ISR_TCIF(DMA_CHANNEL3)
#define DMA_ISR_TCIF4			DMA_ISR_TCIF(DMA_CHANNEL4)
#define DMA_ISR_TCIF5			DMA_ISR_TCIF(DMA_CHANNEL5)
#define DMA_ISR_TCIF6			DMA_ISR_TCIF(DMA_CHANNEL6)
#define DMA_ISR_TCIF7			DMA_ISR_TCIF(DMA_CHANNEL7)

/* GIF: Global interrupt flag */
#define DMA_ISR_GIF_BIT			(1 << 0)
#define DMA_ISR_GIF(channel)		(DMA_ISR_GIF_BIT << (4 * ((channel) -1)))

#define DMA_ISR_GIF1			DMA_ISR_GIF(DMA_CHANNEL1)
#define DMA_ISR_GIF2			DMA_ISR_GIF(DMA_CHANNEL2)
#define DMA_ISR_GIF3			DMA_ISR_GIF(DMA_CHANNEL3)
#define DMA_ISR_GIF4			DMA_ISR_GIF(DMA_CHANNEL4)
#define DMA_ISR_GIF5			DMA_ISR_GIF(DMA_CHANNEL5)
#define DMA_ISR_GIF6			DMA_ISR_GIF(DMA_CHANNEL6)
#define DMA_ISR_GIF7			DMA_ISR_GIF(DMA_CHANNEL7)

/* --- DMA_IFCR values ----------------------------------------------------- */

/* CTEIF: Transfer error clear */
#define DMA_IFCR_CTEIF_BIT     		(1 << 3)
#define DMA_IFCR_CTEIF(channel)		(DMA_IFCR_CTEIF_BIT << (4 * ((channel) -1)))

#define DMA_IFCR_CTEIF1			DMA_IFCR_CTEIF(DMA_CHANNEL1)
#define DMA_IFCR_CTEIF2			DMA_IFCR_CTEIF(DMA_CHANNEL2)
#define DMA_IFCR_CTEIF3			DMA_IFCR_CTEIF(DMA_CHANNEL3)
#define DMA_IFCR_CTEIF4			DMA_IFCR_CTEIF(DMA_CHANNEL4)
#define DMA_IFCR_CTEIF5			DMA_IFCR_CTEIF(DMA_CHANNEL5)
#define DMA_IFCR_CTEIF6			DMA_IFCR_CTEIF(DMA_CHANNEL6)
#define DMA_IFCR_CTEIF7			DMA_IFCR_CTEIF(DMA_CHANNEL7)

/* CHTIF: Half transfer clear */
#define DMA_IFCR_CHTIF_BIT     		(1 << 2)
#define DMA_IFCR_CHTIF(channel)		(DMA_IFCR_CHTIF_BIT << (4 * ((channel) -1)))

#define DMA_IFCR_CHTIF1			DMA_IFCR_CHTIF(DMA_CHANNEL1)
#define DMA_IFCR_CHTIF2			DMA_IFCR_CHTIF(DMA_CHANNEL2)
#define DMA_IFCR_CHTIF3			DMA_IFCR_CHTIF(DMA_CHANNEL3)
#define DMA_IFCR_CHTIF4			DMA_IFCR_CHTIF(DMA_CHANNEL4)
#define DMA_IFCR_CHTIF5			DMA_IFCR_CHTIF(DMA_CHANNEL5)
#define DMA_IFCR_CHTIF6			DMA_IFCR_CHTIF(DMA_CHANNEL6)
#define DMA_IFCR_CHTIF7			DMA_IFCR_CHTIF(DMA_CHANNEL7)

/* CTCIF: Transfer complete clear */
#define DMA_IFCR_CTCIF_BIT     		(1 << 1)
#define DMA_IFCR_CTCIF(channel)		(DMA_IFCR_CTCIF_BIT << (4 * ((channel) -1)))

#define DMA_IFCR_CTCIF1			DMA_IFCR_CTCIF(DMA_CHANNEL1)
#define DMA_IFCR_CTCIF2			DMA_IFCR_CTCIF(DMA_CHANNEL2)
#define DMA_IFCR_CTCIF3			DMA_IFCR_CTCIF(DMA_CHANNEL3)
#define DMA_IFCR_CTCIF4			DMA_IFCR_CTCIF(DMA_CHANNEL4)
#define DMA_IFCR_CTCIF5			DMA_IFCR_CTCIF(DMA_CHANNEL5)
#define DMA_IFCR_CTCIF6			DMA_IFCR_CTCIF(DMA_CHANNEL6)
#define DMA_IFCR_CTCIF7			DMA_IFCR_CTCIF(DMA_CHANNEL7)

/* CGIF: Global interrupt clear */
#define DMA_IFCR_CGIF_BIT      		(1 << 0)
#define DMA_IFCR_CGIF(channel)		(DMA_IFCR_CGIF_BIT << (4 * ((channel) -1)))

#define DMA_IFCR_CGIF1			DMA_IFCR_CGIF(DMA_CHANNEL1)
#define DMA_IFCR_CGIF2			DMA_IFCR_CGIF(DMA_CHANNEL2)
#define DMA_IFCR_CGIF3			DMA_IFCR_CGIF(DMA_CHANNEL3)
#define DMA_IFCR_CGIF4			DMA_IFCR_CGIF(DMA_CHANNEL4)
#define DMA_IFCR_CGIF5			DMA_IFCR_CGIF(DMA_CHANNEL5)
#define DMA_IFCR_CGIF6			DMA_IFCR_CGIF(DMA_CHANNEL6)
#define DMA_IFCR_CGIF7			DMA_IFCR_CGIF(DMA_CHANNEL7)

/* Clear interrupts mask */
#define DMA_IFCR_CIF_BIT       		0xF
#define DMA_IFCR_CIF(channel)		(DMA_IFCR_CIF_BIT << (4 * ((channel) - 1)))

#define DMA_IFCR_CIF1			DMA_IFCR_CIF(DMA_CHANNEL1)
#define DMA_IFCR_CIF2			DMA_IFCR_CIF(DMA_CHANNEL2)
#define DMA_IFCR_CIF3			DMA_IFCR_CIF(DMA_CHANNEL3)
#define DMA_IFCR_CIF4			DMA_IFCR_CIF(DMA_CHANNEL4)
#define DMA_IFCR_CIF5			DMA_IFCR_CIF(DMA_CHANNEL5)
#define DMA_IFCR_CIF6			DMA_IFCR_CIF(DMA_CHANNEL6)
#define DMA_IFCR_CIF7			DMA_IFCR_CIF(DMA_CHANNEL7)

/* --- DMA_CCRx generic values --------------------------------------------- */

/* MEM2MEM: Memory to memory mode */
#define DMA_CCR_MEM2MEM			(1 << 14)

/* PL[13:12]: Channel priority level */
/** @defgroup dma_ch_pri DMA Channel Priority Levels
@ingroup STM32F1xx_dma_defines

@{*/
#define DMA_CCR_PL_LOW			(0x0 << 12)
#define DMA_CCR_PL_MEDIUM		(0x1 << 12)
#define DMA_CCR_PL_HIGH			(0x2 << 12)
#define DMA_CCR_PL_VERY_HIGH		(0x3 << 12)
/**@}*/
#define DMA_CCR_PL_MASK			(0x3 << 12)
#define DMA_CCR_PL_SHIFT		12

/* MSIZE[11:10]: Memory size */
/** @defgroup dma_ch_memwidth DMA Channel Memory Word Width
@ingroup STM32F1xx_dma_defines

@{*/
#define DMA_CCR_MSIZE_8BIT		(0x0 << 10)
#define DMA_CCR_MSIZE_16BIT		(0x1 << 10)
#define DMA_CCR_MSIZE_32BIT		(0x2 << 10)
/**@}*/
#define DMA_CCR_MSIZE_MASK		(0x3 << 10)
#define DMA_CCR_MSIZE_SHIFT		10

/* PSIZE[9:8]: Peripheral size */
/** @defgroup dma_ch_perwidth DMA Channel Peripheral Word Width
@ingroup STM32F1xx_dma_defines

@{*/
#define DMA_CCR_PSIZE_8BIT		(0x0 << 8)
#define DMA_CCR_PSIZE_16BIT		(0x1 << 8)
#define DMA_CCR_PSIZE_32BIT		(0x2 << 8)
/**@}*/
#define DMA_CCR_PSIZE_MASK		(0x3 << 8)
#define DMA_CCR_PSIZE_SHIFT		8

/* MINC: Memory increment mode */
#define DMA_CCR_MINC			(1 << 7)

/* PINC: Peripheral increment mode */
#define DMA_CCR_PINC			(1 << 6)

/* CIRC: Circular mode */
#define DMA_CCR_CIRC			(1 << 5)

/* DIR: Data transfer direction */
#define DMA_CCR_DIR			(1 << 4)

/* TEIE: Transfer error interrupt enable */
#define DMA_CCR_TEIE			(1 << 3)

/* HTIE: Half transfer interrupt enable */
#define DMA_CCR_HTIE			(1 << 2)

/* TCIE: Transfer complete interrupt enable */
#define DMA_CCR_TCIE			(1 << 1)

/* EN: Channel enable */
#define DMA_CCR_EN			(1 << 0)

/* --- DMA_CNDTRx values --------------------------------------------------- */

/* NDT[15:0]: Number of data to transfer */

/* --- DMA_CPARx values ---------------------------------------------------- */

/* PA[31:0]: Peripheral address */

/* --- DMA_CMARx values ---------------------------------------------------- */

/* MA[31:0]: Memory address */

/* --- Generic values ------------------------------------------------------ */

/** @defgroup dma_ch DMA Channel Number
@ingroup STM32F1xx_dma_defines

@{*/
#define DMA_CHANNEL1			1
#define DMA_CHANNEL2			2
#define DMA_CHANNEL3			3
#define DMA_CHANNEL4			4
#define DMA_CHANNEL5			5
#define DMA_CHANNEL6			6
#define DMA_CHANNEL7			7
/**@}*/

/* --- function prototypes ------------------------------------------------- */

BEGIN_DECLS

void dma_channel_reset(u32 dma, u8 channel);
void dma_enable_mem2mem_mode(u32 dma, u8 channel);
void dma_set_priority(u32 dma, u8 channel, u32 prio);
void dma_set_memory_size(u32 dma, u8 channel, u32 mem_size);
void dma_set_peripheral_size(u32 dma, u8 channel, u32 peripheral_size);
void dma_enable_memory_increment_mode(u32 dma, u8 channel);
void dma_enable_peripheral_increment_mode(u32 dma, u8 channel);
void dma_enable_circular_mode(u32 dma, u8 channel);
void dma_set_read_from_peripheral(u32 dma, u8 channel);
void dma_set_read_from_memory(u32 dma, u8 channel);
void dma_enable_transfer_error_interrupt(u32 dma, u8 channel);
void dma_disable_transfer_error_interrupt(u32 dma, u8 channel);
void dma_enable_half_transfer_interrupt(u32 dma, u8 channel);
void dma_disable_half_transfer_interrupt(u32 dma, u8 channel);
void dma_enable_transfer_complete_interrupt(u32 dma, u8 channel);
void dma_disable_transfer_complete_interrupt(u32 dma, u8 channel);
void dma_enable_channel(u32 dma, u8 channel);
void dma_disable_channel(u32 dma, u8 channel);
void dma_set_peripheral_address(u32 dma, u8 channel, u32 address);
void dma_set_memory_address(u32 dma, u8 channel, u32 address);
void dma_set_number_of_data(u32 dma, u8 channel, u16 number);

END_DECLS

#endif
/**@}*/