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
|
/************************************************************************************
* arch/arm/src/lpc17xx/lpc17_gpdma.h
*
* Copyright (C) 2010, 2013 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
************************************************************************************/
#ifndef __ARCH_ARM_SRC_LPC17XX_LPC17_GPDMA_H
#define __ARCH_ARM_SRC_LPC17XX_LPC17_GPDMA_H
/************************************************************************************
* Included Files
************************************************************************************/
#include <nuttx/config.h>
#include "chip/lpc17_gpdma.h"
/************************************************************************************
* Pre-processor Definitions
************************************************************************************/
/************************************************************************************
* Public Types
************************************************************************************/
#ifdef CONFIG_LPC17_GPDMA
/* DMA_HANDLE is an opaque reference to an allocated DMA channel */
typedef FAR void *DMA_HANDLE;
/* dma_callback_t a function pointer provided to lp17_dmastart. This function is
* called at the completion of the DMA transfer. 'arg' is the same 'arg' value
* that was provided when lpc17_dmastart() was called and result indicates the result
* of the transfer: Zero indicates a successful tranfers. On failure, a negated
* errno is returned indicating the general nature of the DMA faiure.
*/
typedef void (*dma_callback_t)(DMA_HANDLE handle, void *arg, int result);
/* The following is used for sampling DMA registers when CONFIG DEBUG_DMA is selected */
#ifdef CONFIG_DEBUG_DMA
struct lpc17_dmaglobalregs_s
{
/* Global Registers */
uint32_t intst; /* DMA Interrupt Status Register */
uint32_t inttcst; /* DMA Interrupt Terminal Count Request Status Register */
uint32_t interrst; /* DMA Interrupt Error Status Register */
uint32_t rawinttcst; /* DMA Raw Interrupt Terminal Count Status Register */
uint32_t rawinterrst; /* DMA Raw Error Interrupt Status Register */
uint32_t enbldchns; /* DMA Enabled Channel Register */
uint32_t softbreq; /* DMA Software Burst Request Register */
uint32_t softsreq; /* DMA Software Single Request Register */
uint32_t softlbreq; /* DMA Software Last Burst Request Register */
uint32_t softlsreq; /* DMA Software Last Single Request Register */
uint32_t config; /* DMA Configuration Register */
uint32_t sync; /* DMA Synchronization Register */
};
struct lpc17_dmachanregs_s
{
/* Channel Registers */
uint32_t srcaddr; /* DMA Channel Source Address Register */
uint32_t destaddr; /* DMA Channel Destination Address Register */
uint32_t lli; /* DMA Channel Linked List Item Register */
uint32_t control; /* DMA Channel Control Register */
uint32_t config; /* DMA Channel Configuration Register */
};
struct lpc17_dmaregs_s
{
/* Global Registers */
struct lpc17_dmaglobalregs_s gbl;
/* Channel Registers */
struct lpc17_dmachanregs_s ch;
};
#endif /* CONFIG_DEBUG_DMA */
/************************************************************************************
* Public Data
************************************************************************************/
#ifndef __ASSEMBLY__
#ifdef __cplusplus
extern "C"
{
#endif
/************************************************************************************
* Public Functions
************************************************************************************/
/****************************************************************************
* Name: lpc17_dmainitialize
*
* Description:
* Initialize the GPDMA subsystem.
*
* Returned Value:
* None
*
****************************************************************************/
void lpc17_dmainitilaize(void);
/****************************************************************************
* Name: lpc17_dmaconfigure
*
* Description:
* Configure a DMA request. Each DMA request may have two different DMA
* request sources. This associates one of the sources with a DMA request.
*
* Returned Value:
* None
*
****************************************************************************/
void lpc17_dmaconfigure(uint8_t dmarequest, bool alternate);
/****************************************************************************
* Name: lpc17_dmachannel
*
* Description:
* Allocate a DMA channel. This function sets aside a DMA channel and
* gives the caller exclusive access to the DMA channel.
*
* Returned Value:
* One success, this function returns a non-NULL, void* DMA channel
* handle. NULL is returned on any failure. This function can fail only
* if no DMA channel is available.
*
****************************************************************************/
DMA_HANDLE lpc17_dmachannel(void);
/****************************************************************************
* Name: lpc17_dmafree
*
* Description:
* Release a DMA channel. NOTE: The 'handle' used in this argument must
* NEVER be used again until lpc17_dmachannel() is called again to re-gain
* a valid handle.
*
* Returned Value:
* None
*
****************************************************************************/
void lpc17_dmafree(DMA_HANDLE handle);
/****************************************************************************
* Name: lpc17_dmasetup
*
* Description:
* Configure DMA for one transfer.
*
****************************************************************************/
int lpc17_dmasetup(DMA_HANDLE handle, uint32_t control, uint32_t config,
uint32_t srcaddr, uint32_t destaddr, size_t nxfrs);
/****************************************************************************
* Name: lpc17_dmastart
*
* Description:
* Start the DMA transfer
*
****************************************************************************/
int lpc17_dmastart(DMA_HANDLE handle, dma_callback_t callback, void *arg);
/****************************************************************************
* Name: lpc17_dmastop
*
* Description:
* Cancel the DMA. After lpc17_dmastop() is called, the DMA channel is
* reset and lpc17_dmasetup() must be called before lpc17_dmastart() can be
* called again
*
****************************************************************************/
void lpc17_dmastop(DMA_HANDLE handle);
/****************************************************************************
* Name: lpc17_dmasample
*
* Description:
* Sample DMA register contents
*
****************************************************************************/
#ifdef CONFIG_DEBUG_DMA
EXTERN void lpc17_dmasample(DMA_HANDLE handle, struct lpc17_dmaregs_s *regs);
#else
# define lpc17_dmasample(handle,regs)
#endif
/****************************************************************************
* Name: lpc17_dmadump
*
* Description:
* Dump previously sampled DMA register contents
*
****************************************************************************/
#ifdef CONFIG_DEBUG_DMA
EXTERN void lpc17_dmadump(DMA_HANDLE handle, const struct lpc17_dmaregs_s *regs,
const char *msg);
#else
# define lpc17_dmadump(handle,regs,msg)
#endif
#ifdef __cplusplus
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* CONFIG_LPC17_GPDMA */
#endif /* __ARCH_ARM_SRC_LPC17XX_LPC17_GPDMA_H */
|
