mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_SAMR21G18A/TOOLCHAIN_ARM_STD/dma_api_HAL.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_SAMD21J18A/TARGET_Atmel/TARGET_SAM_CortexM0P/dma_api_HAL.h@156:ff21514d8981 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 * Copyright (c) 2006-2015 ARM Limited
AnnaBridge 156:ff21514d8981 3 *
AnnaBridge 156:ff21514d8981 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 5 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 6 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 7 *
AnnaBridge 156:ff21514d8981 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 9 *
AnnaBridge 156:ff21514d8981 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 13 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 14 * limitations under the License.
AnnaBridge 156:ff21514d8981 15 */
AnnaBridge 156:ff21514d8981 16
AnnaBridge 156:ff21514d8981 17 #ifndef _DMA_API_HAL_H
AnnaBridge 156:ff21514d8981 18 #define _DMA_API_HAL_H
AnnaBridge 156:ff21514d8981 19
AnnaBridge 156:ff21514d8981 20 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 21 extern "C" {
AnnaBridge 156:ff21514d8981 22 #endif
AnnaBridge 156:ff21514d8981 23
AnnaBridge 156:ff21514d8981 24 #include <compiler.h>
AnnaBridge 156:ff21514d8981 25 #include "dma.h"
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 enum dma_status_flags {
AnnaBridge 156:ff21514d8981 28 DMA_NOT_USED = (uint32_t)1,
AnnaBridge 156:ff21514d8981 29 DMA_ALLOCATED = (DMA_NOT_USED << 1),
AnnaBridge 156:ff21514d8981 30 DMA_TEMPORARY = (DMA_NOT_USED << 2),
AnnaBridge 156:ff21514d8981 31 DMA_ERROR = (DMA_NOT_USED << 3),
AnnaBridge 156:ff21514d8981 32 };
AnnaBridge 156:ff21514d8981 33
AnnaBridge 156:ff21514d8981 34 /* No other capabilities supported now */
AnnaBridge 156:ff21514d8981 35 #define DMA_CAP_NONE 0
AnnaBridge 156:ff21514d8981 36
AnnaBridge 156:ff21514d8981 37 #define DMA_ADDRESS_INC_DISABLE 0
AnnaBridge 156:ff21514d8981 38 #define DMA_ADDRESS_INC_ENABLE 1
AnnaBridge 156:ff21514d8981 39
AnnaBridge 156:ff21514d8981 40 #define DMA_TRANSFER_ERROR ((uint32_t)1 << 1)
AnnaBridge 156:ff21514d8981 41 #define DMA_TRANSFER_COMPLETE ((uint32_t)1 << 2)
AnnaBridge 156:ff21514d8981 42
AnnaBridge 156:ff21514d8981 43 #define DMA_EVENT_ALL (DMA_TRANSFER_ERROR | DMA_TRANSFER_COMPLETE)
AnnaBridge 156:ff21514d8981 44
AnnaBridge 156:ff21514d8981 45
AnnaBridge 156:ff21514d8981 46 COMPILER_ALIGNED(16)
AnnaBridge 156:ff21514d8981 47 struct dma_instance_s {
AnnaBridge 156:ff21514d8981 48 struct dma_resource resource;
AnnaBridge 156:ff21514d8981 49 DmacDescriptor descriptor;
AnnaBridge 156:ff21514d8981 50 uint8_t status;
AnnaBridge 156:ff21514d8981 51 uint32_t events;
AnnaBridge 156:ff21514d8981 52 uint32_t handler;
AnnaBridge 156:ff21514d8981 53 };
AnnaBridge 156:ff21514d8981 54
AnnaBridge 156:ff21514d8981 55 /** Setup a DMA descriptor for specified resource
AnnaBridge 156:ff21514d8981 56 *
AnnaBridge 156:ff21514d8981 57 * @param[in] channel_index DMA channel id
AnnaBridge 156:ff21514d8981 58 * @param[in] src source address
AnnaBridge 156:ff21514d8981 59 * @param[in] src_inc_enable source address auto increment enable flag
AnnaBridge 156:ff21514d8981 60 * @param[in] desc destination address
AnnaBridge 156:ff21514d8981 61 * @param[in] desc_inc_enable destination address auto increment enable flag
AnnaBridge 156:ff21514d8981 62 * @param[in] length length of data to be transferred
AnnaBridge 156:ff21514d8981 63 * @param[in] beat_size beat size to be set
AnnaBridge 156:ff21514d8981 64 * @return void
AnnaBridge 156:ff21514d8981 65 */
AnnaBridge 156:ff21514d8981 66 void dma_setup_transfer(uint8_t channelid, uint32_t src, bool src_inc_enable, uint32_t desc, bool desc_inc_enable, uint32_t length, uint8_t beat_size);
AnnaBridge 156:ff21514d8981 67
AnnaBridge 156:ff21514d8981 68 /** Start DMA transfer
AnnaBridge 156:ff21514d8981 69 *
AnnaBridge 156:ff21514d8981 70 * Kick starts transfer in DMA channel with specified channel id
AnnaBridge 156:ff21514d8981 71 * @param[in] channelid Channel id of DMA channel
AnnaBridge 156:ff21514d8981 72 * @return non zero if success otherwise zero
AnnaBridge 156:ff21514d8981 73 */
AnnaBridge 156:ff21514d8981 74 bool dma_start_transfer(int channelid);
AnnaBridge 156:ff21514d8981 75
AnnaBridge 156:ff21514d8981 76 /** DMA channel busy check
AnnaBridge 156:ff21514d8981 77 *
AnnaBridge 156:ff21514d8981 78 * To check whether DMA channel is busy with a job or not
AnnaBridge 156:ff21514d8981 79 * @param[in] channelid Channel id of DMA channel
AnnaBridge 156:ff21514d8981 80 * @return non zero if busy otherwise zero
AnnaBridge 156:ff21514d8981 81 */
AnnaBridge 156:ff21514d8981 82 bool dma_busy(int channelid);
AnnaBridge 156:ff21514d8981 83
AnnaBridge 156:ff21514d8981 84 /** DMA channel transfer completion check
AnnaBridge 156:ff21514d8981 85 *
AnnaBridge 156:ff21514d8981 86 * To check whether DMA channel job is completed or not
AnnaBridge 156:ff21514d8981 87 * @param[in] channelid Channel id of DMA channel
AnnaBridge 156:ff21514d8981 88 * @return non zero if busy otherwise zero
AnnaBridge 156:ff21514d8981 89 */
AnnaBridge 156:ff21514d8981 90 bool dma_is_transfer_complete(int channelid);
AnnaBridge 156:ff21514d8981 91
AnnaBridge 156:ff21514d8981 92 /** Registers callback function for DMA
AnnaBridge 156:ff21514d8981 93 *
AnnaBridge 156:ff21514d8981 94 * Registers callback function for DMA for specified events
AnnaBridge 156:ff21514d8981 95 * @param[in] channelid Channel id of DMA channel
AnnaBridge 156:ff21514d8981 96 * @param[in] handler Callback function pointer
AnnaBridge 156:ff21514d8981 97 * @param[in] event Events mask
AnnaBridge 156:ff21514d8981 98 * @return void
AnnaBridge 156:ff21514d8981 99 */
AnnaBridge 156:ff21514d8981 100 void dma_set_handler(int channelid, uint32_t handler, uint32_t event);
AnnaBridge 156:ff21514d8981 101
AnnaBridge 156:ff21514d8981 102 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 103 }
AnnaBridge 156:ff21514d8981 104 #endif
AnnaBridge 156:ff21514d8981 105
AnnaBridge 156:ff21514d8981 106 #endif /* _DMA_API_HAL_H */