-
Notifications
You must be signed in to change notification settings - Fork 39
/
hal_dma.c
366 lines (320 loc) · 11.9 KB
/
hal_dma.c
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
/****************************************************************************
**
** Copyright (C) ${COPYRIGHT_YEAR} MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
/*!
* @file hal_dma.c
* @brief This file contains all the functions prototypes for the DMA library.
*/
#include "hal_dma.h"
#include "hal_ll_dma.h"
/*!< @brief Sets module, stream and channel to first free one. */
#define set_module_stream_and_channel_default() obj->module = i; \
obj->stream = j; \
obj->channel = k;
/*!< @brief Sets module, stream and channel to user defined values. */
#define set_module_stream_and_channel() obj->module = config->module; \
obj->stream = config->stream; \
obj->channel = config->channel;
/**
* @brief Local static global handler.
* + DMA_NUM_OF_MODULES defined per MCU.
* + DMA_NUM_OF_STREAMS defined per MCU.
* + DMA_NUM_OF_CHANNELS defined per MCU.
*/
static hal_dma_channel_t dma_channels = {0};
/**
* @brief Checks if desired stream and channel are available on current MCU.
*/
static inline bool check_limit( hal_dma_t *obj )
{
return (((obj->config.stream < DMA_NUM_OF_STREAMS) && (obj->config.stream != 0xFF) && \
(obj->config.channel < DMA_NUM_OF_CHANNELS) && (obj->config.channel != 0xFF)) ? (true) : (false));
}
void hal_dma_configure_default( hal_dma_config_t *config )
{
if ( config ) {
/**
* Fill all values to default ones.
* Leave only channel as UNINITIALIZED.
*/
config->module = 0xFF;
config->stream = 0xFF;
config->channel = 0xFF;
config->direction = HAL_DMA_DIRECTION_DEFAULT;
config->mode = HAL_DMA_MODE_DEFAULT;
config->priority = HAL_DMA_PRIORITY_DEFAULT;
/**
* Set memory values to default ones.
*/
config->source_inc = false;
config->data_align_source = HAL_DMA_DATA_ALIGN_DEFAULT;
config->burst_size_source = HAL_DMA_BURST_SIZE_INCREMENT_DEFAULT;
/**
* Set peripheral values to default ones.
*/
config->destination_inc = false;
config->data_align_destination = HAL_DMA_DATA_ALIGN_DEFAULT;
config->burst_size_destination = HAL_DMA_BURST_SIZE_INCREMENT_DEFAULT;
/**
* Set transfer values to default ones.
*/
config->addr_src = 0;
config->addr_dst = 0;
config->transfer_length = 0;
}
}
void hal_dma_get_channels( hal_dma_channel_t *channels )
{
if ( channels ) {
/*!< Used to check which channels are available. */
memcpy( channels, dma_channels, sizeof(hal_dma_channel_t) );
}
}
err_t hal_dma_open( hal_dma_t *obj, hal_dma_config_t *config )
{
err_t status = HAL_DMA_ERROR;
bool channel_found = false;
if ( obj ) {
if ( !obj->allocated ) {
/**
* First copy the config structure contents
* to object handle.
*/
hal_dma_config_t *p_config = &obj->config;
memcpy( p_config, config, sizeof( hal_dma_config_t ) );
/* Then check if stream and channel are within limits. */
if ( check_limit( obj ) ) {
if ( 0xFF == config->module ) {
for ( int i = 0; i < DMA_NUM_OF_MODULES; i++ ) {
if ( 0xFF == config->stream ) {
for ( int j = 0; j < DMA_NUM_OF_STREAMS; j++ ) {
if ( 0xFF == config->channel ) {
for ( int k = 0; k < DMA_NUM_OF_CHANNELS; k++ ) {
if ( !dma_channels[i][j][k] ) {
/**
* If default channel is set,
* iterate through maximum number of channels
* for current stream and settle for first that
* hasn't been allocated yet.
*/
set_module_stream_and_channel_default();
status = HAL_DMA_SUCCESS;
channel_found = true;
break;
}
}
}
}
}
if ( channel_found )
break;
}
} else {
/*!< Allocate user desired channel. */
set_module_stream_and_channel();
status = HAL_DMA_SUCCESS;
}
}
}
}
/**
* If last status was a success proceed with module
* hardware initialization.
*/
if ( HAL_DMA_SUCCESS == status ) {
obj->allocated = true;
obj->initialized = false;
/*!< Set stream/channel as allocated. */
dma_channels[obj->module][obj->stream][obj->channel] = HAL_DMA_STATE_ALLOCATED;
status = hal_ll_dma_init( (hal_ll_dma_t *)obj );
if ( HAL_DMA_SUCCESS == status ) {
obj->initialized = true;
}
}
/**
* If it reaches here, invalid pointers have
* been passed to API.
*/
return status;
}
err_t hal_dma_set_mode( hal_dma_t *obj, hal_dma_mode_t mode )
{
err_t status = HAL_DMA_ERROR;
if ( obj ) {
if ( obj->allocated ) {
/**
* Abort any transfer before continuing.
* Set dma mode - normal or circular.
*/
if ( obj->initialized ) {
(void)hal_dma_transfer_abort( obj );
status = hal_ll_dma_set_mode( (hal_ll_dma_t *)obj, (hal_ll_dma_mode_t)mode );
if ( HAL_LL_DMA_SUCCESS == status ) {
// Map new value to object.
obj->config.mode = mode;
}
}
}
}
return status;
}
err_t hal_dma_set_direction( hal_dma_t *obj, hal_dma_direction_t direction )
{
err_t status = HAL_DMA_ERROR;
if ( obj ) {
if ( obj->allocated ) {
/**
* Abort any transfer before continuing.
* Set dma direction.
* M2M/M2P/P2M/P2P
*/
if ( obj->initialized ) {
(void)hal_dma_transfer_abort( obj );
status = hal_ll_dma_set_direction( (hal_ll_dma_t *)obj, (hal_ll_dma_direction_t)direction );
if ( HAL_LL_DMA_SUCCESS == status ) {
// Map new value to object.
obj->config.direction = direction;
}
}
}
}
return status;
}
err_t hal_dma_set_priority( hal_dma_t *obj, hal_dma_priority_t priority )
{
err_t status = HAL_DMA_ERROR;
if ( obj ) {
if ( obj->allocated ) {
/**
* Abort any transfer before continuing.
* Set priority of currently active channel.
*/
if ( obj->initialized ) {
(void)hal_dma_transfer_abort( obj );
status = hal_ll_dma_set_priority( (hal_ll_dma_t *)obj, (hal_ll_dma_priority_t)priority );
if ( HAL_LL_DMA_SUCCESS == status ) {
// Map new value to object.
obj->config.priority = priority;
}
}
}
}
return status;
}
err_t hal_dma_set_transfer_config( hal_dma_t *obj, uint32_t addr_src, uint32_t addr_dst, size_t transfer_size, hal_dma_source_memory_region_t src_mem_type )
{
err_t status = HAL_DMA_ERROR;
if ( obj ) {
if ( obj->allocated ) {
obj->config.addr_src = addr_src;
obj->config.addr_dst = addr_dst;
obj->config.transfer_length = transfer_size;
/**
* Abort any transfer before continuing.
* Configure the transfer type using
* standard HAL config APIs.
*/
if ( obj->initialized ) {
(void)hal_dma_transfer_abort( obj );
status = HAL_DMA_SUCCESS;
status |= hal_dma_set_mode( obj, obj->config.mode );
status |= hal_dma_set_direction( obj, obj->config.direction );
status |= hal_dma_set_priority( obj, obj->config.priority );
status |= hal_ll_dma_set_parameters( (hal_ll_dma_t *)obj, addr_src, addr_dst, transfer_size, (hal_ll_dma_source_memory_region_t)src_mem_type );
}
}
}
return status;
}
err_t hal_dma_transfer_start( hal_dma_t *obj )
{
err_t status = HAL_DMA_ERROR;
if ( obj ) {
if ( obj->allocated ) {
/*!< Initialize transfer. */
if ( obj->initialized ) {
status = hal_ll_dma_transfer_start( (hal_ll_dma_t *)obj );
}
}
}
return status;
}
err_t hal_dma_transfer_stop( hal_dma_t *obj )
{
err_t status = HAL_DMA_ERROR;
if ( obj ) {
if ( obj->allocated ) {
/*!< Stop transfer. */
if ( obj->initialized ) {
status = hal_ll_dma_transfer_stop( (hal_ll_dma_t *)obj );
}
}
}
return status;
}
err_t hal_dma_transfer_abort( hal_dma_t *obj )
{
err_t status = HAL_DMA_ERROR;
if ( obj ) {
if ( obj->allocated ) {
/*!< Abort any ongoing transfer. */
if ( obj->initialized ) {
status = hal_ll_dma_transfer_abort( (hal_ll_dma_t *)obj );
}
}
}
return status;
}
err_t hal_dma_close( hal_dma_t *obj )
{
if ( obj ) {
if ( obj->allocated ) {
/*!< Abort any ongoing transfer. */
(void)hal_dma_transfer_abort( obj );
if ( obj->initialized ) {
hal_ll_dma_deinit( (hal_ll_dma_t *)obj );
}
/*!< Reset current stream channel handle to HAL_DMA_STATE_FREE. */
dma_channels[obj->module][obj->stream][obj->channel] = HAL_DMA_STATE_FREE;
/*!< Reset all data to 0. */
memset(obj, 0, sizeof(hal_dma_t));
}
}
return HAL_DMA_SUCCESS;
}
// ------------------------------------------------------------------------- END