mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/fsl_edma.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 3 * All rights reserved.
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 6 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 9 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 13 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 189:f392fc9709a3 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 17 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 18 *
AnnaBridge 189:f392fc9709a3 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 29 */
AnnaBridge 189:f392fc9709a3 30
AnnaBridge 189:f392fc9709a3 31 #ifndef _FSL_EDMA_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_EDMA_H_
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #include "fsl_common.h"
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 /*!
AnnaBridge 189:f392fc9709a3 37 * @addtogroup edma
AnnaBridge 189:f392fc9709a3 38 * @{
AnnaBridge 189:f392fc9709a3 39 */
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 42 * Definitions
AnnaBridge 189:f392fc9709a3 43 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 44
AnnaBridge 189:f392fc9709a3 45 /*! @name Driver version */
AnnaBridge 189:f392fc9709a3 46 /*@{*/
AnnaBridge 189:f392fc9709a3 47 /*! @brief eDMA driver version */
AnnaBridge 189:f392fc9709a3 48 #define FSL_EDMA_DRIVER_VERSION (MAKE_VERSION(2, 1, 1)) /*!< Version 2.1.1. */
AnnaBridge 189:f392fc9709a3 49 /*@}*/
AnnaBridge 189:f392fc9709a3 50
AnnaBridge 189:f392fc9709a3 51 /*! @brief Compute the offset unit from DCHPRI3 */
AnnaBridge 189:f392fc9709a3 52 #define DMA_DCHPRI_INDEX(channel) (((channel) & ~0x03U) | (3 - ((channel)&0x03U)))
AnnaBridge 189:f392fc9709a3 53
AnnaBridge 189:f392fc9709a3 54 /*! @brief Get the pointer of DCHPRIn */
AnnaBridge 189:f392fc9709a3 55 #define DMA_DCHPRIn(base, channel) ((volatile uint8_t *)&(base->DCHPRI3))[DMA_DCHPRI_INDEX(channel)]
AnnaBridge 189:f392fc9709a3 56
AnnaBridge 189:f392fc9709a3 57 /*! @brief eDMA transfer configuration */
AnnaBridge 189:f392fc9709a3 58 typedef enum _edma_transfer_size
AnnaBridge 189:f392fc9709a3 59 {
AnnaBridge 189:f392fc9709a3 60 kEDMA_TransferSize1Bytes = 0x0U, /*!< Source/Destination data transfer size is 1 byte every time */
AnnaBridge 189:f392fc9709a3 61 kEDMA_TransferSize2Bytes = 0x1U, /*!< Source/Destination data transfer size is 2 bytes every time */
AnnaBridge 189:f392fc9709a3 62 kEDMA_TransferSize4Bytes = 0x2U, /*!< Source/Destination data transfer size is 4 bytes every time */
AnnaBridge 189:f392fc9709a3 63 kEDMA_TransferSize16Bytes = 0x4U, /*!< Source/Destination data transfer size is 16 bytes every time */
AnnaBridge 189:f392fc9709a3 64 kEDMA_TransferSize32Bytes = 0x5U, /*!< Source/Destination data transfer size is 32 bytes every time */
AnnaBridge 189:f392fc9709a3 65 } edma_transfer_size_t;
AnnaBridge 189:f392fc9709a3 66
AnnaBridge 189:f392fc9709a3 67 /*! @brief eDMA modulo configuration */
AnnaBridge 189:f392fc9709a3 68 typedef enum _edma_modulo
AnnaBridge 189:f392fc9709a3 69 {
AnnaBridge 189:f392fc9709a3 70 kEDMA_ModuloDisable = 0x0U, /*!< Disable modulo */
AnnaBridge 189:f392fc9709a3 71 kEDMA_Modulo2bytes, /*!< Circular buffer size is 2 bytes. */
AnnaBridge 189:f392fc9709a3 72 kEDMA_Modulo4bytes, /*!< Circular buffer size is 4 bytes. */
AnnaBridge 189:f392fc9709a3 73 kEDMA_Modulo8bytes, /*!< Circular buffer size is 8 bytes. */
AnnaBridge 189:f392fc9709a3 74 kEDMA_Modulo16bytes, /*!< Circular buffer size is 16 bytes. */
AnnaBridge 189:f392fc9709a3 75 kEDMA_Modulo32bytes, /*!< Circular buffer size is 32 bytes. */
AnnaBridge 189:f392fc9709a3 76 kEDMA_Modulo64bytes, /*!< Circular buffer size is 64 bytes. */
AnnaBridge 189:f392fc9709a3 77 kEDMA_Modulo128bytes, /*!< Circular buffer size is 128 bytes. */
AnnaBridge 189:f392fc9709a3 78 kEDMA_Modulo256bytes, /*!< Circular buffer size is 256 bytes. */
AnnaBridge 189:f392fc9709a3 79 kEDMA_Modulo512bytes, /*!< Circular buffer size is 512 bytes. */
AnnaBridge 189:f392fc9709a3 80 kEDMA_Modulo1Kbytes, /*!< Circular buffer size is 1 K bytes. */
AnnaBridge 189:f392fc9709a3 81 kEDMA_Modulo2Kbytes, /*!< Circular buffer size is 2 K bytes. */
AnnaBridge 189:f392fc9709a3 82 kEDMA_Modulo4Kbytes, /*!< Circular buffer size is 4 K bytes. */
AnnaBridge 189:f392fc9709a3 83 kEDMA_Modulo8Kbytes, /*!< Circular buffer size is 8 K bytes. */
AnnaBridge 189:f392fc9709a3 84 kEDMA_Modulo16Kbytes, /*!< Circular buffer size is 16 K bytes. */
AnnaBridge 189:f392fc9709a3 85 kEDMA_Modulo32Kbytes, /*!< Circular buffer size is 32 K bytes. */
AnnaBridge 189:f392fc9709a3 86 kEDMA_Modulo64Kbytes, /*!< Circular buffer size is 64 K bytes. */
AnnaBridge 189:f392fc9709a3 87 kEDMA_Modulo128Kbytes, /*!< Circular buffer size is 128 K bytes. */
AnnaBridge 189:f392fc9709a3 88 kEDMA_Modulo256Kbytes, /*!< Circular buffer size is 256 K bytes. */
AnnaBridge 189:f392fc9709a3 89 kEDMA_Modulo512Kbytes, /*!< Circular buffer size is 512 K bytes. */
AnnaBridge 189:f392fc9709a3 90 kEDMA_Modulo1Mbytes, /*!< Circular buffer size is 1 M bytes. */
AnnaBridge 189:f392fc9709a3 91 kEDMA_Modulo2Mbytes, /*!< Circular buffer size is 2 M bytes. */
AnnaBridge 189:f392fc9709a3 92 kEDMA_Modulo4Mbytes, /*!< Circular buffer size is 4 M bytes. */
AnnaBridge 189:f392fc9709a3 93 kEDMA_Modulo8Mbytes, /*!< Circular buffer size is 8 M bytes. */
AnnaBridge 189:f392fc9709a3 94 kEDMA_Modulo16Mbytes, /*!< Circular buffer size is 16 M bytes. */
AnnaBridge 189:f392fc9709a3 95 kEDMA_Modulo32Mbytes, /*!< Circular buffer size is 32 M bytes. */
AnnaBridge 189:f392fc9709a3 96 kEDMA_Modulo64Mbytes, /*!< Circular buffer size is 64 M bytes. */
AnnaBridge 189:f392fc9709a3 97 kEDMA_Modulo128Mbytes, /*!< Circular buffer size is 128 M bytes. */
AnnaBridge 189:f392fc9709a3 98 kEDMA_Modulo256Mbytes, /*!< Circular buffer size is 256 M bytes. */
AnnaBridge 189:f392fc9709a3 99 kEDMA_Modulo512Mbytes, /*!< Circular buffer size is 512 M bytes. */
AnnaBridge 189:f392fc9709a3 100 kEDMA_Modulo1Gbytes, /*!< Circular buffer size is 1 G bytes. */
AnnaBridge 189:f392fc9709a3 101 kEDMA_Modulo2Gbytes, /*!< Circular buffer size is 2 G bytes. */
AnnaBridge 189:f392fc9709a3 102 } edma_modulo_t;
AnnaBridge 189:f392fc9709a3 103
AnnaBridge 189:f392fc9709a3 104 /*! @brief Bandwidth control */
AnnaBridge 189:f392fc9709a3 105 typedef enum _edma_bandwidth
AnnaBridge 189:f392fc9709a3 106 {
AnnaBridge 189:f392fc9709a3 107 kEDMA_BandwidthStallNone = 0x0U, /*!< No eDMA engine stalls. */
AnnaBridge 189:f392fc9709a3 108 kEDMA_BandwidthStall4Cycle = 0x2U, /*!< eDMA engine stalls for 4 cycles after each read/write. */
AnnaBridge 189:f392fc9709a3 109 kEDMA_BandwidthStall8Cycle = 0x3U, /*!< eDMA engine stalls for 8 cycles after each read/write. */
AnnaBridge 189:f392fc9709a3 110 } edma_bandwidth_t;
AnnaBridge 189:f392fc9709a3 111
AnnaBridge 189:f392fc9709a3 112 /*! @brief Channel link type */
AnnaBridge 189:f392fc9709a3 113 typedef enum _edma_channel_link_type
AnnaBridge 189:f392fc9709a3 114 {
AnnaBridge 189:f392fc9709a3 115 kEDMA_LinkNone = 0x0U, /*!< No channel link */
AnnaBridge 189:f392fc9709a3 116 kEDMA_MinorLink, /*!< Channel link after each minor loop */
AnnaBridge 189:f392fc9709a3 117 kEDMA_MajorLink, /*!< Channel link while major loop count exhausted */
AnnaBridge 189:f392fc9709a3 118 } edma_channel_link_type_t;
AnnaBridge 189:f392fc9709a3 119
AnnaBridge 189:f392fc9709a3 120 /*!@brief eDMA channel status flags. */
AnnaBridge 189:f392fc9709a3 121 enum _edma_channel_status_flags
AnnaBridge 189:f392fc9709a3 122 {
AnnaBridge 189:f392fc9709a3 123 kEDMA_DoneFlag = 0x1U, /*!< DONE flag, set while transfer finished, CITER value exhausted*/
AnnaBridge 189:f392fc9709a3 124 kEDMA_ErrorFlag = 0x2U, /*!< eDMA error flag, an error occurred in a transfer */
AnnaBridge 189:f392fc9709a3 125 kEDMA_InterruptFlag = 0x4U, /*!< eDMA interrupt flag, set while an interrupt occurred of this channel */
AnnaBridge 189:f392fc9709a3 126 };
AnnaBridge 189:f392fc9709a3 127
AnnaBridge 189:f392fc9709a3 128 /*! @brief eDMA channel error status flags. */
AnnaBridge 189:f392fc9709a3 129 enum _edma_error_status_flags
AnnaBridge 189:f392fc9709a3 130 {
AnnaBridge 189:f392fc9709a3 131 kEDMA_DestinationBusErrorFlag = DMA_ES_DBE_MASK, /*!< Bus error on destination address */
AnnaBridge 189:f392fc9709a3 132 kEDMA_SourceBusErrorFlag = DMA_ES_SBE_MASK, /*!< Bus error on the source address */
AnnaBridge 189:f392fc9709a3 133 kEDMA_ScatterGatherErrorFlag = DMA_ES_SGE_MASK, /*!< Error on the Scatter/Gather address, not 32byte aligned. */
AnnaBridge 189:f392fc9709a3 134 kEDMA_NbytesErrorFlag = DMA_ES_NCE_MASK, /*!< NBYTES/CITER configuration error */
AnnaBridge 189:f392fc9709a3 135 kEDMA_DestinationOffsetErrorFlag = DMA_ES_DOE_MASK, /*!< Destination offset not aligned with destination size */
AnnaBridge 189:f392fc9709a3 136 kEDMA_DestinationAddressErrorFlag = DMA_ES_DAE_MASK, /*!< Destination address not aligned with destination size */
AnnaBridge 189:f392fc9709a3 137 kEDMA_SourceOffsetErrorFlag = DMA_ES_SOE_MASK, /*!< Source offset not aligned with source size */
AnnaBridge 189:f392fc9709a3 138 kEDMA_SourceAddressErrorFlag = DMA_ES_SAE_MASK, /*!< Source address not aligned with source size*/
AnnaBridge 189:f392fc9709a3 139 kEDMA_ErrorChannelFlag = DMA_ES_ERRCHN_MASK, /*!< Error channel number of the cancelled channel number */
AnnaBridge 189:f392fc9709a3 140 kEDMA_ChannelPriorityErrorFlag = DMA_ES_CPE_MASK, /*!< Channel priority is not unique. */
AnnaBridge 189:f392fc9709a3 141 kEDMA_TransferCanceledFlag = DMA_ES_ECX_MASK, /*!< Transfer cancelled */
AnnaBridge 189:f392fc9709a3 142 #if defined(FSL_FEATURE_EDMA_CHANNEL_GROUP_COUNT) && FSL_FEATURE_EDMA_CHANNEL_GROUP_COUNT > 1
AnnaBridge 189:f392fc9709a3 143 kEDMA_GroupPriorityErrorFlag = DMA_ES_GPE_MASK, /*!< Group priority is not unique. */
AnnaBridge 189:f392fc9709a3 144 #endif
AnnaBridge 189:f392fc9709a3 145 kEDMA_ValidFlag = DMA_ES_VLD_MASK, /*!< No error occurred, this bit is 0. Otherwise, it is 1. */
AnnaBridge 189:f392fc9709a3 146 };
AnnaBridge 189:f392fc9709a3 147
AnnaBridge 189:f392fc9709a3 148 /*! @brief eDMA interrupt source */
AnnaBridge 189:f392fc9709a3 149 typedef enum _edma_interrupt_enable
AnnaBridge 189:f392fc9709a3 150 {
AnnaBridge 189:f392fc9709a3 151 kEDMA_ErrorInterruptEnable = 0x1U, /*!< Enable interrupt while channel error occurs. */
AnnaBridge 189:f392fc9709a3 152 kEDMA_MajorInterruptEnable = DMA_CSR_INTMAJOR_MASK, /*!< Enable interrupt while major count exhausted. */
AnnaBridge 189:f392fc9709a3 153 kEDMA_HalfInterruptEnable = DMA_CSR_INTHALF_MASK, /*!< Enable interrupt while major count to half value. */
AnnaBridge 189:f392fc9709a3 154 } edma_interrupt_enable_t;
AnnaBridge 189:f392fc9709a3 155
AnnaBridge 189:f392fc9709a3 156 /*! @brief eDMA transfer type */
AnnaBridge 189:f392fc9709a3 157 typedef enum _edma_transfer_type
AnnaBridge 189:f392fc9709a3 158 {
AnnaBridge 189:f392fc9709a3 159 kEDMA_MemoryToMemory = 0x0U, /*!< Transfer from memory to memory */
AnnaBridge 189:f392fc9709a3 160 kEDMA_PeripheralToMemory, /*!< Transfer from peripheral to memory */
AnnaBridge 189:f392fc9709a3 161 kEDMA_MemoryToPeripheral, /*!< Transfer from memory to peripheral */
AnnaBridge 189:f392fc9709a3 162 } edma_transfer_type_t;
AnnaBridge 189:f392fc9709a3 163
AnnaBridge 189:f392fc9709a3 164 /*! @brief eDMA transfer status */
AnnaBridge 189:f392fc9709a3 165 enum _edma_transfer_status
AnnaBridge 189:f392fc9709a3 166 {
AnnaBridge 189:f392fc9709a3 167 kStatus_EDMA_QueueFull = MAKE_STATUS(kStatusGroup_EDMA, 0), /*!< TCD queue is full. */
AnnaBridge 189:f392fc9709a3 168 kStatus_EDMA_Busy = MAKE_STATUS(kStatusGroup_EDMA, 1), /*!< Channel is busy and can't handle the
AnnaBridge 189:f392fc9709a3 169 transfer request. */
AnnaBridge 189:f392fc9709a3 170 };
AnnaBridge 189:f392fc9709a3 171
AnnaBridge 189:f392fc9709a3 172 /*! @brief eDMA global configuration structure.*/
AnnaBridge 189:f392fc9709a3 173 typedef struct _edma_config
AnnaBridge 189:f392fc9709a3 174 {
AnnaBridge 189:f392fc9709a3 175 bool enableContinuousLinkMode; /*!< Enable (true) continuous link mode. Upon minor loop completion, the channel
AnnaBridge 189:f392fc9709a3 176 activates again if that channel has a minor loop channel link enabled and
AnnaBridge 189:f392fc9709a3 177 the link channel is itself. */
AnnaBridge 189:f392fc9709a3 178 bool enableHaltOnError; /*!< Enable (true) transfer halt on error. Any error causes the HALT bit to set.
AnnaBridge 189:f392fc9709a3 179 Subsequently, all service requests are ignored until the HALT bit is cleared.*/
AnnaBridge 189:f392fc9709a3 180 bool enableRoundRobinArbitration; /*!< Enable (true) round robin channel arbitration method or fixed priority
AnnaBridge 189:f392fc9709a3 181 arbitration is used for channel selection */
AnnaBridge 189:f392fc9709a3 182 bool enableDebugMode; /*!< Enable(true) eDMA debug mode. When in debug mode, the eDMA stalls the start of
AnnaBridge 189:f392fc9709a3 183 a new channel. Executing channels are allowed to complete. */
AnnaBridge 189:f392fc9709a3 184 } edma_config_t;
AnnaBridge 189:f392fc9709a3 185
AnnaBridge 189:f392fc9709a3 186 /*!
AnnaBridge 189:f392fc9709a3 187 * @brief eDMA transfer configuration
AnnaBridge 189:f392fc9709a3 188 *
AnnaBridge 189:f392fc9709a3 189 * This structure configures the source/destination transfer attribute.
AnnaBridge 189:f392fc9709a3 190 * This figure shows the eDMA's transfer model:
AnnaBridge 189:f392fc9709a3 191 * _________________________________________________
AnnaBridge 189:f392fc9709a3 192 * | Transfer Size | |
AnnaBridge 189:f392fc9709a3 193 * Minor Loop |_______________| Major loop Count 1 |
AnnaBridge 189:f392fc9709a3 194 * Bytes | Transfer Size | |
AnnaBridge 189:f392fc9709a3 195 * ____________|_______________|____________________|--> Minor loop complete
AnnaBridge 189:f392fc9709a3 196 * ____________________________________
AnnaBridge 189:f392fc9709a3 197 * | | |
AnnaBridge 189:f392fc9709a3 198 * |_______________| Major Loop Count 2 |
AnnaBridge 189:f392fc9709a3 199 * | | |
AnnaBridge 189:f392fc9709a3 200 * |_______________|____________________|--> Minor loop Complete
AnnaBridge 189:f392fc9709a3 201 *
AnnaBridge 189:f392fc9709a3 202 * ---------------------------------------------------------> Transfer complete
AnnaBridge 189:f392fc9709a3 203 */
AnnaBridge 189:f392fc9709a3 204 typedef struct _edma_transfer_config
AnnaBridge 189:f392fc9709a3 205 {
AnnaBridge 189:f392fc9709a3 206 uint32_t srcAddr; /*!< Source data address. */
AnnaBridge 189:f392fc9709a3 207 uint32_t destAddr; /*!< Destination data address. */
AnnaBridge 189:f392fc9709a3 208 edma_transfer_size_t srcTransferSize; /*!< Source data transfer size. */
AnnaBridge 189:f392fc9709a3 209 edma_transfer_size_t destTransferSize; /*!< Destination data transfer size. */
AnnaBridge 189:f392fc9709a3 210 int16_t srcOffset; /*!< Sign-extended offset applied to the current source address to
AnnaBridge 189:f392fc9709a3 211 form the next-state value as each source read is completed. */
AnnaBridge 189:f392fc9709a3 212 int16_t destOffset; /*!< Sign-extended offset applied to the current destination address to
AnnaBridge 189:f392fc9709a3 213 form the next-state value as each destination write is completed. */
AnnaBridge 189:f392fc9709a3 214 uint32_t minorLoopBytes; /*!< Bytes to transfer in a minor loop*/
AnnaBridge 189:f392fc9709a3 215 uint32_t majorLoopCounts; /*!< Major loop iteration count. */
AnnaBridge 189:f392fc9709a3 216 } edma_transfer_config_t;
AnnaBridge 189:f392fc9709a3 217
AnnaBridge 189:f392fc9709a3 218 /*! @brief eDMA channel priority configuration */
AnnaBridge 189:f392fc9709a3 219 typedef struct _edma_channel_Preemption_config
AnnaBridge 189:f392fc9709a3 220 {
AnnaBridge 189:f392fc9709a3 221 bool enableChannelPreemption; /*!< If true: a channel can be suspended by other channel with higher priority */
AnnaBridge 189:f392fc9709a3 222 bool enablePreemptAbility; /*!< If true: a channel can suspend other channel with low priority */
AnnaBridge 189:f392fc9709a3 223 uint8_t channelPriority; /*!< Channel priority */
AnnaBridge 189:f392fc9709a3 224 } edma_channel_Preemption_config_t;
AnnaBridge 189:f392fc9709a3 225
AnnaBridge 189:f392fc9709a3 226 /*! @brief eDMA minor offset configuration */
AnnaBridge 189:f392fc9709a3 227 typedef struct _edma_minor_offset_config
AnnaBridge 189:f392fc9709a3 228 {
AnnaBridge 189:f392fc9709a3 229 bool enableSrcMinorOffset; /*!< Enable(true) or Disable(false) source minor loop offset. */
AnnaBridge 189:f392fc9709a3 230 bool enableDestMinorOffset; /*!< Enable(true) or Disable(false) destination minor loop offset. */
AnnaBridge 189:f392fc9709a3 231 uint32_t minorOffset; /*!< Offset for a minor loop mapping. */
AnnaBridge 189:f392fc9709a3 232 } edma_minor_offset_config_t;
AnnaBridge 189:f392fc9709a3 233
AnnaBridge 189:f392fc9709a3 234 /*!
AnnaBridge 189:f392fc9709a3 235 * @brief eDMA TCD.
AnnaBridge 189:f392fc9709a3 236 *
AnnaBridge 189:f392fc9709a3 237 * This structure is same as TCD register which is described in reference manual,
AnnaBridge 189:f392fc9709a3 238 * and is used to configure the scatter/gather feature as a next hardware TCD.
AnnaBridge 189:f392fc9709a3 239 */
AnnaBridge 189:f392fc9709a3 240 typedef struct _edma_tcd
AnnaBridge 189:f392fc9709a3 241 {
AnnaBridge 189:f392fc9709a3 242 __IO uint32_t SADDR; /*!< SADDR register, used to save source address */
AnnaBridge 189:f392fc9709a3 243 __IO uint16_t SOFF; /*!< SOFF register, save offset bytes every transfer */
AnnaBridge 189:f392fc9709a3 244 __IO uint16_t ATTR; /*!< ATTR register, source/destination transfer size and modulo */
AnnaBridge 189:f392fc9709a3 245 __IO uint32_t NBYTES; /*!< Nbytes register, minor loop length in bytes */
AnnaBridge 189:f392fc9709a3 246 __IO uint32_t SLAST; /*!< SLAST register */
AnnaBridge 189:f392fc9709a3 247 __IO uint32_t DADDR; /*!< DADDR register, used for destination address */
AnnaBridge 189:f392fc9709a3 248 __IO uint16_t DOFF; /*!< DOFF register, used for destination offset */
AnnaBridge 189:f392fc9709a3 249 __IO uint16_t CITER; /*!< CITER register, current minor loop numbers, for unfinished minor loop.*/
AnnaBridge 189:f392fc9709a3 250 __IO uint32_t DLAST_SGA; /*!< DLASTSGA register, next stcd address used in scatter-gather mode */
AnnaBridge 189:f392fc9709a3 251 __IO uint16_t CSR; /*!< CSR register, for TCD control status */
AnnaBridge 189:f392fc9709a3 252 __IO uint16_t BITER; /*!< BITER register, begin minor loop count. */
AnnaBridge 189:f392fc9709a3 253 } edma_tcd_t;
AnnaBridge 189:f392fc9709a3 254
AnnaBridge 189:f392fc9709a3 255 /*! @brief Callback for eDMA */
AnnaBridge 189:f392fc9709a3 256 struct _edma_handle;
AnnaBridge 189:f392fc9709a3 257
AnnaBridge 189:f392fc9709a3 258 /*! @brief Define callback function for eDMA. */
AnnaBridge 189:f392fc9709a3 259 typedef void (*edma_callback)(struct _edma_handle *handle, void *userData, bool transferDone, uint32_t tcds);
AnnaBridge 189:f392fc9709a3 260
AnnaBridge 189:f392fc9709a3 261 /*! @brief eDMA transfer handle structure */
AnnaBridge 189:f392fc9709a3 262 typedef struct _edma_handle
AnnaBridge 189:f392fc9709a3 263 {
AnnaBridge 189:f392fc9709a3 264 edma_callback callback; /*!< Callback function for major count exhausted. */
AnnaBridge 189:f392fc9709a3 265 void *userData; /*!< Callback function parameter. */
AnnaBridge 189:f392fc9709a3 266 DMA_Type *base; /*!< eDMA peripheral base address. */
AnnaBridge 189:f392fc9709a3 267 edma_tcd_t *tcdPool; /*!< Pointer to memory stored TCDs. */
AnnaBridge 189:f392fc9709a3 268 uint8_t channel; /*!< eDMA channel number. */
AnnaBridge 189:f392fc9709a3 269 volatile int8_t header; /*!< The first TCD index. Should point to the next TCD to be loaded into the eDMA engine. */
AnnaBridge 189:f392fc9709a3 270 volatile int8_t tail; /*!< The last TCD index. Should point to the next TCD to be stored into the memory pool. */
AnnaBridge 189:f392fc9709a3 271 volatile int8_t tcdUsed; /*!< The number of used TCD slots. Should reflect the number of TCDs can be used/loaded in
AnnaBridge 189:f392fc9709a3 272 the memory. */
AnnaBridge 189:f392fc9709a3 273 volatile int8_t tcdSize; /*!< The total number of TCD slots in the queue. */
AnnaBridge 189:f392fc9709a3 274 uint8_t flags; /*!< The status of the current channel. */
AnnaBridge 189:f392fc9709a3 275 } edma_handle_t;
AnnaBridge 189:f392fc9709a3 276
AnnaBridge 189:f392fc9709a3 277 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 278 * APIs
AnnaBridge 189:f392fc9709a3 279 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 280 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 281 extern "C" {
AnnaBridge 189:f392fc9709a3 282 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 283
AnnaBridge 189:f392fc9709a3 284 /*!
AnnaBridge 189:f392fc9709a3 285 * @name eDMA initialization and de-initialization
AnnaBridge 189:f392fc9709a3 286 * @{
AnnaBridge 189:f392fc9709a3 287 */
AnnaBridge 189:f392fc9709a3 288
AnnaBridge 189:f392fc9709a3 289 /*!
AnnaBridge 189:f392fc9709a3 290 * @brief Initializes the eDMA peripheral.
AnnaBridge 189:f392fc9709a3 291 *
AnnaBridge 189:f392fc9709a3 292 * This function ungates the eDMA clock and configures the eDMA peripheral according
AnnaBridge 189:f392fc9709a3 293 * to the configuration structure.
AnnaBridge 189:f392fc9709a3 294 *
AnnaBridge 189:f392fc9709a3 295 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 296 * @param config A pointer to the configuration structure, see "edma_config_t".
AnnaBridge 189:f392fc9709a3 297 * @note This function enables the minor loop map feature.
AnnaBridge 189:f392fc9709a3 298 */
AnnaBridge 189:f392fc9709a3 299 void EDMA_Init(DMA_Type *base, const edma_config_t *config);
AnnaBridge 189:f392fc9709a3 300
AnnaBridge 189:f392fc9709a3 301 /*!
AnnaBridge 189:f392fc9709a3 302 * @brief Deinitializes the eDMA peripheral.
AnnaBridge 189:f392fc9709a3 303 *
AnnaBridge 189:f392fc9709a3 304 * This function gates the eDMA clock.
AnnaBridge 189:f392fc9709a3 305 *
AnnaBridge 189:f392fc9709a3 306 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 307 */
AnnaBridge 189:f392fc9709a3 308 void EDMA_Deinit(DMA_Type *base);
AnnaBridge 189:f392fc9709a3 309
AnnaBridge 189:f392fc9709a3 310 /*!
AnnaBridge 189:f392fc9709a3 311 * @brief Gets the eDMA default configuration structure.
AnnaBridge 189:f392fc9709a3 312 *
AnnaBridge 189:f392fc9709a3 313 * This function sets the configuration structure to default values.
AnnaBridge 189:f392fc9709a3 314 * The default configuration is set to the following values.
AnnaBridge 189:f392fc9709a3 315 * @code
AnnaBridge 189:f392fc9709a3 316 * config.enableContinuousLinkMode = false;
AnnaBridge 189:f392fc9709a3 317 * config.enableHaltOnError = true;
AnnaBridge 189:f392fc9709a3 318 * config.enableRoundRobinArbitration = false;
AnnaBridge 189:f392fc9709a3 319 * config.enableDebugMode = false;
AnnaBridge 189:f392fc9709a3 320 * @endcode
AnnaBridge 189:f392fc9709a3 321 *
AnnaBridge 189:f392fc9709a3 322 * @param config A pointer to the eDMA configuration structure.
AnnaBridge 189:f392fc9709a3 323 */
AnnaBridge 189:f392fc9709a3 324 void EDMA_GetDefaultConfig(edma_config_t *config);
AnnaBridge 189:f392fc9709a3 325
AnnaBridge 189:f392fc9709a3 326 /* @} */
AnnaBridge 189:f392fc9709a3 327 /*!
AnnaBridge 189:f392fc9709a3 328 * @name eDMA Channel Operation
AnnaBridge 189:f392fc9709a3 329 * @{
AnnaBridge 189:f392fc9709a3 330 */
AnnaBridge 189:f392fc9709a3 331
AnnaBridge 189:f392fc9709a3 332 /*!
AnnaBridge 189:f392fc9709a3 333 * @brief Sets all TCD registers to default values.
AnnaBridge 189:f392fc9709a3 334 *
AnnaBridge 189:f392fc9709a3 335 * This function sets TCD registers for this channel to default values.
AnnaBridge 189:f392fc9709a3 336 *
AnnaBridge 189:f392fc9709a3 337 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 338 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 339 * @note This function must not be called while the channel transfer is ongoing
AnnaBridge 189:f392fc9709a3 340 * or it causes unpredictable results.
AnnaBridge 189:f392fc9709a3 341 * @note This function enables the auto stop request feature.
AnnaBridge 189:f392fc9709a3 342 */
AnnaBridge 189:f392fc9709a3 343 void EDMA_ResetChannel(DMA_Type *base, uint32_t channel);
AnnaBridge 189:f392fc9709a3 344
AnnaBridge 189:f392fc9709a3 345 /*!
AnnaBridge 189:f392fc9709a3 346 * @brief Configures the eDMA transfer attribute.
AnnaBridge 189:f392fc9709a3 347 *
AnnaBridge 189:f392fc9709a3 348 * This function configures the transfer attribute, including source address, destination address,
AnnaBridge 189:f392fc9709a3 349 * transfer size, address offset, and so on. It also configures the scatter gather feature if the
AnnaBridge 189:f392fc9709a3 350 * user supplies the TCD address.
AnnaBridge 189:f392fc9709a3 351 * Example:
AnnaBridge 189:f392fc9709a3 352 * @code
AnnaBridge 189:f392fc9709a3 353 * edma_transfer_t config;
AnnaBridge 189:f392fc9709a3 354 * edma_tcd_t tcd;
AnnaBridge 189:f392fc9709a3 355 * config.srcAddr = ..;
AnnaBridge 189:f392fc9709a3 356 * config.destAddr = ..;
AnnaBridge 189:f392fc9709a3 357 * ...
AnnaBridge 189:f392fc9709a3 358 * EDMA_SetTransferConfig(DMA0, channel, &config, &stcd);
AnnaBridge 189:f392fc9709a3 359 * @endcode
AnnaBridge 189:f392fc9709a3 360 *
AnnaBridge 189:f392fc9709a3 361 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 362 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 363 * @param config Pointer to eDMA transfer configuration structure.
AnnaBridge 189:f392fc9709a3 364 * @param nextTcd Point to TCD structure. It can be NULL if users
AnnaBridge 189:f392fc9709a3 365 * do not want to enable scatter/gather feature.
AnnaBridge 189:f392fc9709a3 366 * @note If nextTcd is not NULL, it means scatter gather feature is enabled
AnnaBridge 189:f392fc9709a3 367 * and DREQ bit is cleared in the previous transfer configuration, which
AnnaBridge 189:f392fc9709a3 368 * is set in the eDMA_ResetChannel.
AnnaBridge 189:f392fc9709a3 369 */
AnnaBridge 189:f392fc9709a3 370 void EDMA_SetTransferConfig(DMA_Type *base,
AnnaBridge 189:f392fc9709a3 371 uint32_t channel,
AnnaBridge 189:f392fc9709a3 372 const edma_transfer_config_t *config,
AnnaBridge 189:f392fc9709a3 373 edma_tcd_t *nextTcd);
AnnaBridge 189:f392fc9709a3 374
AnnaBridge 189:f392fc9709a3 375 /*!
AnnaBridge 189:f392fc9709a3 376 * @brief Configures the eDMA minor offset feature.
AnnaBridge 189:f392fc9709a3 377 *
AnnaBridge 189:f392fc9709a3 378 * The minor offset means that the signed-extended value is added to the source address or destination
AnnaBridge 189:f392fc9709a3 379 * address after each minor loop.
AnnaBridge 189:f392fc9709a3 380 *
AnnaBridge 189:f392fc9709a3 381 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 382 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 383 * @param config A pointer to the minor offset configuration structure.
AnnaBridge 189:f392fc9709a3 384 */
AnnaBridge 189:f392fc9709a3 385 void EDMA_SetMinorOffsetConfig(DMA_Type *base, uint32_t channel, const edma_minor_offset_config_t *config);
AnnaBridge 189:f392fc9709a3 386
AnnaBridge 189:f392fc9709a3 387 /*!
AnnaBridge 189:f392fc9709a3 388 * @brief Configures the eDMA channel preemption feature.
AnnaBridge 189:f392fc9709a3 389 *
AnnaBridge 189:f392fc9709a3 390 * This function configures the channel preemption attribute and the priority of the channel.
AnnaBridge 189:f392fc9709a3 391 *
AnnaBridge 189:f392fc9709a3 392 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 393 * @param channel eDMA channel number
AnnaBridge 189:f392fc9709a3 394 * @param config A pointer to the channel preemption configuration structure.
AnnaBridge 189:f392fc9709a3 395 */
AnnaBridge 189:f392fc9709a3 396 static inline void EDMA_SetChannelPreemptionConfig(DMA_Type *base,
AnnaBridge 189:f392fc9709a3 397 uint32_t channel,
AnnaBridge 189:f392fc9709a3 398 const edma_channel_Preemption_config_t *config)
AnnaBridge 189:f392fc9709a3 399 {
AnnaBridge 189:f392fc9709a3 400 assert(channel < FSL_FEATURE_EDMA_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 401 assert(config != NULL);
AnnaBridge 189:f392fc9709a3 402
AnnaBridge 189:f392fc9709a3 403 DMA_DCHPRIn(base, channel) =
AnnaBridge 189:f392fc9709a3 404 (DMA_DCHPRI0_DPA(!config->enablePreemptAbility) | DMA_DCHPRI0_ECP(config->enableChannelPreemption) |
AnnaBridge 189:f392fc9709a3 405 DMA_DCHPRI0_CHPRI(config->channelPriority));
AnnaBridge 189:f392fc9709a3 406 }
AnnaBridge 189:f392fc9709a3 407
AnnaBridge 189:f392fc9709a3 408 /*!
AnnaBridge 189:f392fc9709a3 409 * @brief Sets the channel link for the eDMA transfer.
AnnaBridge 189:f392fc9709a3 410 *
AnnaBridge 189:f392fc9709a3 411 * This function configures either the minor link or the major link mode. The minor link means that the channel link is
AnnaBridge 189:f392fc9709a3 412 * triggered every time CITER decreases by 1. The major link means that the channel link is triggered when the CITER is
AnnaBridge 189:f392fc9709a3 413 * exhausted.
AnnaBridge 189:f392fc9709a3 414 *
AnnaBridge 189:f392fc9709a3 415 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 416 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 417 * @param type A channel link type, which can be one of the following:
AnnaBridge 189:f392fc9709a3 418 * @arg kEDMA_LinkNone
AnnaBridge 189:f392fc9709a3 419 * @arg kEDMA_MinorLink
AnnaBridge 189:f392fc9709a3 420 * @arg kEDMA_MajorLink
AnnaBridge 189:f392fc9709a3 421 * @param linkedChannel The linked channel number.
AnnaBridge 189:f392fc9709a3 422 * @note Users should ensure that DONE flag is cleared before calling this interface, or the configuration is invalid.
AnnaBridge 189:f392fc9709a3 423 */
AnnaBridge 189:f392fc9709a3 424 void EDMA_SetChannelLink(DMA_Type *base, uint32_t channel, edma_channel_link_type_t type, uint32_t linkedChannel);
AnnaBridge 189:f392fc9709a3 425
AnnaBridge 189:f392fc9709a3 426 /*!
AnnaBridge 189:f392fc9709a3 427 * @brief Sets the bandwidth for the eDMA transfer.
AnnaBridge 189:f392fc9709a3 428 *
AnnaBridge 189:f392fc9709a3 429 * Because the eDMA processes the minor loop, it continuously generates read/write sequences
AnnaBridge 189:f392fc9709a3 430 * until the minor count is exhausted. The bandwidth forces the eDMA to stall after the completion of
AnnaBridge 189:f392fc9709a3 431 * each read/write access to control the bus request bandwidth seen by the crossbar switch.
AnnaBridge 189:f392fc9709a3 432 *
AnnaBridge 189:f392fc9709a3 433 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 434 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 435 * @param bandWidth A bandwidth setting, which can be one of the following:
AnnaBridge 189:f392fc9709a3 436 * @arg kEDMABandwidthStallNone
AnnaBridge 189:f392fc9709a3 437 * @arg kEDMABandwidthStall4Cycle
AnnaBridge 189:f392fc9709a3 438 * @arg kEDMABandwidthStall8Cycle
AnnaBridge 189:f392fc9709a3 439 */
AnnaBridge 189:f392fc9709a3 440 void EDMA_SetBandWidth(DMA_Type *base, uint32_t channel, edma_bandwidth_t bandWidth);
AnnaBridge 189:f392fc9709a3 441
AnnaBridge 189:f392fc9709a3 442 /*!
AnnaBridge 189:f392fc9709a3 443 * @brief Sets the source modulo and the destination modulo for the eDMA transfer.
AnnaBridge 189:f392fc9709a3 444 *
AnnaBridge 189:f392fc9709a3 445 * This function defines a specific address range specified to be the value after (SADDR + SOFF)/(DADDR + DOFF)
AnnaBridge 189:f392fc9709a3 446 * calculation is performed or the original register value. It provides the ability to implement a circular data
AnnaBridge 189:f392fc9709a3 447 * queue easily.
AnnaBridge 189:f392fc9709a3 448 *
AnnaBridge 189:f392fc9709a3 449 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 450 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 451 * @param srcModulo A source modulo value.
AnnaBridge 189:f392fc9709a3 452 * @param destModulo A destination modulo value.
AnnaBridge 189:f392fc9709a3 453 */
AnnaBridge 189:f392fc9709a3 454 void EDMA_SetModulo(DMA_Type *base, uint32_t channel, edma_modulo_t srcModulo, edma_modulo_t destModulo);
AnnaBridge 189:f392fc9709a3 455
AnnaBridge 189:f392fc9709a3 456 #if defined(FSL_FEATURE_EDMA_ASYNCHRO_REQUEST_CHANNEL_COUNT) && FSL_FEATURE_EDMA_ASYNCHRO_REQUEST_CHANNEL_COUNT
AnnaBridge 189:f392fc9709a3 457 /*!
AnnaBridge 189:f392fc9709a3 458 * @brief Enables an async request for the eDMA transfer.
AnnaBridge 189:f392fc9709a3 459 *
AnnaBridge 189:f392fc9709a3 460 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 461 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 462 * @param enable The command to enable (true) or disable (false).
AnnaBridge 189:f392fc9709a3 463 */
AnnaBridge 189:f392fc9709a3 464 static inline void EDMA_EnableAsyncRequest(DMA_Type *base, uint32_t channel, bool enable)
AnnaBridge 189:f392fc9709a3 465 {
AnnaBridge 189:f392fc9709a3 466 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 467
AnnaBridge 189:f392fc9709a3 468 base->EARS = (base->EARS & (~(1U << channel))) | ((uint32_t)enable << channel);
AnnaBridge 189:f392fc9709a3 469 }
AnnaBridge 189:f392fc9709a3 470 #endif /* FSL_FEATURE_EDMA_ASYNCHRO_REQUEST_CHANNEL_COUNT */
AnnaBridge 189:f392fc9709a3 471
AnnaBridge 189:f392fc9709a3 472 /*!
AnnaBridge 189:f392fc9709a3 473 * @brief Enables an auto stop request for the eDMA transfer.
AnnaBridge 189:f392fc9709a3 474 *
AnnaBridge 189:f392fc9709a3 475 * If enabling the auto stop request, the eDMA hardware automatically disables the hardware channel request.
AnnaBridge 189:f392fc9709a3 476 *
AnnaBridge 189:f392fc9709a3 477 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 478 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 479 * @param enable The command to enable (true) or disable (false).
AnnaBridge 189:f392fc9709a3 480 */
AnnaBridge 189:f392fc9709a3 481 static inline void EDMA_EnableAutoStopRequest(DMA_Type *base, uint32_t channel, bool enable)
AnnaBridge 189:f392fc9709a3 482 {
AnnaBridge 189:f392fc9709a3 483 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 484
AnnaBridge 189:f392fc9709a3 485 base->TCD[channel].CSR = (base->TCD[channel].CSR & (~DMA_CSR_DREQ_MASK)) | DMA_CSR_DREQ(enable);
AnnaBridge 189:f392fc9709a3 486 }
AnnaBridge 189:f392fc9709a3 487
AnnaBridge 189:f392fc9709a3 488 /*!
AnnaBridge 189:f392fc9709a3 489 * @brief Enables the interrupt source for the eDMA transfer.
AnnaBridge 189:f392fc9709a3 490 *
AnnaBridge 189:f392fc9709a3 491 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 492 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 493 * @param mask The mask of interrupt source to be set. Users need to use
AnnaBridge 189:f392fc9709a3 494 * the defined edma_interrupt_enable_t type.
AnnaBridge 189:f392fc9709a3 495 */
AnnaBridge 189:f392fc9709a3 496 void EDMA_EnableChannelInterrupts(DMA_Type *base, uint32_t channel, uint32_t mask);
AnnaBridge 189:f392fc9709a3 497
AnnaBridge 189:f392fc9709a3 498 /*!
AnnaBridge 189:f392fc9709a3 499 * @brief Disables the interrupt source for the eDMA transfer.
AnnaBridge 189:f392fc9709a3 500 *
AnnaBridge 189:f392fc9709a3 501 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 502 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 503 * @param mask The mask of the interrupt source to be set. Use
AnnaBridge 189:f392fc9709a3 504 * the defined edma_interrupt_enable_t type.
AnnaBridge 189:f392fc9709a3 505 */
AnnaBridge 189:f392fc9709a3 506 void EDMA_DisableChannelInterrupts(DMA_Type *base, uint32_t channel, uint32_t mask);
AnnaBridge 189:f392fc9709a3 507
AnnaBridge 189:f392fc9709a3 508 /* @} */
AnnaBridge 189:f392fc9709a3 509 /*!
AnnaBridge 189:f392fc9709a3 510 * @name eDMA TCD Operation
AnnaBridge 189:f392fc9709a3 511 * @{
AnnaBridge 189:f392fc9709a3 512 */
AnnaBridge 189:f392fc9709a3 513
AnnaBridge 189:f392fc9709a3 514 /*!
AnnaBridge 189:f392fc9709a3 515 * @brief Sets all fields to default values for the TCD structure.
AnnaBridge 189:f392fc9709a3 516 *
AnnaBridge 189:f392fc9709a3 517 * This function sets all fields for this TCD structure to default value.
AnnaBridge 189:f392fc9709a3 518 *
AnnaBridge 189:f392fc9709a3 519 * @param tcd Pointer to the TCD structure.
AnnaBridge 189:f392fc9709a3 520 * @note This function enables the auto stop request feature.
AnnaBridge 189:f392fc9709a3 521 */
AnnaBridge 189:f392fc9709a3 522 void EDMA_TcdReset(edma_tcd_t *tcd);
AnnaBridge 189:f392fc9709a3 523
AnnaBridge 189:f392fc9709a3 524 /*!
AnnaBridge 189:f392fc9709a3 525 * @brief Configures the eDMA TCD transfer attribute.
AnnaBridge 189:f392fc9709a3 526 *
AnnaBridge 189:f392fc9709a3 527 * The TCD is a transfer control descriptor. The content of the TCD is the same as the hardware TCD registers.
AnnaBridge 189:f392fc9709a3 528 * The STCD is used in the scatter-gather mode.
AnnaBridge 189:f392fc9709a3 529 * This function configures the TCD transfer attribute, including source address, destination address,
AnnaBridge 189:f392fc9709a3 530 * transfer size, address offset, and so on. It also configures the scatter gather feature if the
AnnaBridge 189:f392fc9709a3 531 * user supplies the next TCD address.
AnnaBridge 189:f392fc9709a3 532 * Example:
AnnaBridge 189:f392fc9709a3 533 * @code
AnnaBridge 189:f392fc9709a3 534 * edma_transfer_t config = {
AnnaBridge 189:f392fc9709a3 535 * ...
AnnaBridge 189:f392fc9709a3 536 * }
AnnaBridge 189:f392fc9709a3 537 * edma_tcd_t tcd __aligned(32);
AnnaBridge 189:f392fc9709a3 538 * edma_tcd_t nextTcd __aligned(32);
AnnaBridge 189:f392fc9709a3 539 * EDMA_TcdSetTransferConfig(&tcd, &config, &nextTcd);
AnnaBridge 189:f392fc9709a3 540 * @endcode
AnnaBridge 189:f392fc9709a3 541 *
AnnaBridge 189:f392fc9709a3 542 * @param tcd Pointer to the TCD structure.
AnnaBridge 189:f392fc9709a3 543 * @param config Pointer to eDMA transfer configuration structure.
AnnaBridge 189:f392fc9709a3 544 * @param nextTcd Pointer to the next TCD structure. It can be NULL if users
AnnaBridge 189:f392fc9709a3 545 * do not want to enable scatter/gather feature.
AnnaBridge 189:f392fc9709a3 546 * @note TCD address should be 32 bytes aligned or it causes an eDMA error.
AnnaBridge 189:f392fc9709a3 547 * @note If the nextTcd is not NULL, the scatter gather feature is enabled
AnnaBridge 189:f392fc9709a3 548 * and DREQ bit is cleared in the previous transfer configuration, which
AnnaBridge 189:f392fc9709a3 549 * is set in the EDMA_TcdReset.
AnnaBridge 189:f392fc9709a3 550 */
AnnaBridge 189:f392fc9709a3 551 void EDMA_TcdSetTransferConfig(edma_tcd_t *tcd, const edma_transfer_config_t *config, edma_tcd_t *nextTcd);
AnnaBridge 189:f392fc9709a3 552
AnnaBridge 189:f392fc9709a3 553 /*!
AnnaBridge 189:f392fc9709a3 554 * @brief Configures the eDMA TCD minor offset feature.
AnnaBridge 189:f392fc9709a3 555 *
AnnaBridge 189:f392fc9709a3 556 * A minor offset is a signed-extended value added to the source address or a destination
AnnaBridge 189:f392fc9709a3 557 * address after each minor loop.
AnnaBridge 189:f392fc9709a3 558 *
AnnaBridge 189:f392fc9709a3 559 * @param tcd A point to the TCD structure.
AnnaBridge 189:f392fc9709a3 560 * @param config A pointer to the minor offset configuration structure.
AnnaBridge 189:f392fc9709a3 561 */
AnnaBridge 189:f392fc9709a3 562 void EDMA_TcdSetMinorOffsetConfig(edma_tcd_t *tcd, const edma_minor_offset_config_t *config);
AnnaBridge 189:f392fc9709a3 563
AnnaBridge 189:f392fc9709a3 564 /*!
AnnaBridge 189:f392fc9709a3 565 * @brief Sets the channel link for the eDMA TCD.
AnnaBridge 189:f392fc9709a3 566 *
AnnaBridge 189:f392fc9709a3 567 * This function configures either a minor link or a major link. The minor link means the channel link is
AnnaBridge 189:f392fc9709a3 568 * triggered every time CITER decreases by 1. The major link means that the channel link is triggered when the CITER is
AnnaBridge 189:f392fc9709a3 569 * exhausted.
AnnaBridge 189:f392fc9709a3 570 *
AnnaBridge 189:f392fc9709a3 571 * @note Users should ensure that DONE flag is cleared before calling this interface, or the configuration is invalid.
AnnaBridge 189:f392fc9709a3 572 * @param tcd Point to the TCD structure.
AnnaBridge 189:f392fc9709a3 573 * @param type Channel link type, it can be one of:
AnnaBridge 189:f392fc9709a3 574 * @arg kEDMA_LinkNone
AnnaBridge 189:f392fc9709a3 575 * @arg kEDMA_MinorLink
AnnaBridge 189:f392fc9709a3 576 * @arg kEDMA_MajorLink
AnnaBridge 189:f392fc9709a3 577 * @param linkedChannel The linked channel number.
AnnaBridge 189:f392fc9709a3 578 */
AnnaBridge 189:f392fc9709a3 579 void EDMA_TcdSetChannelLink(edma_tcd_t *tcd, edma_channel_link_type_t type, uint32_t linkedChannel);
AnnaBridge 189:f392fc9709a3 580
AnnaBridge 189:f392fc9709a3 581 /*!
AnnaBridge 189:f392fc9709a3 582 * @brief Sets the bandwidth for the eDMA TCD.
AnnaBridge 189:f392fc9709a3 583 *
AnnaBridge 189:f392fc9709a3 584 * Because the eDMA processes the minor loop, it continuously generates read/write sequences
AnnaBridge 189:f392fc9709a3 585 * until the minor count is exhausted. The bandwidth forces the eDMA to stall after the completion of
AnnaBridge 189:f392fc9709a3 586 * each read/write access to control the bus request bandwidth seen by the crossbar switch.
AnnaBridge 189:f392fc9709a3 587 * @param tcd A pointer to the TCD structure.
AnnaBridge 189:f392fc9709a3 588 * @param bandWidth A bandwidth setting, which can be one of the following:
AnnaBridge 189:f392fc9709a3 589 * @arg kEDMABandwidthStallNone
AnnaBridge 189:f392fc9709a3 590 * @arg kEDMABandwidthStall4Cycle
AnnaBridge 189:f392fc9709a3 591 * @arg kEDMABandwidthStall8Cycle
AnnaBridge 189:f392fc9709a3 592 */
AnnaBridge 189:f392fc9709a3 593 static inline void EDMA_TcdSetBandWidth(edma_tcd_t *tcd, edma_bandwidth_t bandWidth)
AnnaBridge 189:f392fc9709a3 594 {
AnnaBridge 189:f392fc9709a3 595 assert(tcd != NULL);
AnnaBridge 189:f392fc9709a3 596 assert(((uint32_t)tcd & 0x1FU) == 0);
AnnaBridge 189:f392fc9709a3 597
AnnaBridge 189:f392fc9709a3 598 tcd->CSR = (tcd->CSR & (~DMA_CSR_BWC_MASK)) | DMA_CSR_BWC(bandWidth);
AnnaBridge 189:f392fc9709a3 599 }
AnnaBridge 189:f392fc9709a3 600
AnnaBridge 189:f392fc9709a3 601 /*!
AnnaBridge 189:f392fc9709a3 602 * @brief Sets the source modulo and the destination modulo for the eDMA TCD.
AnnaBridge 189:f392fc9709a3 603 *
AnnaBridge 189:f392fc9709a3 604 * This function defines a specific address range specified to be the value after (SADDR + SOFF)/(DADDR + DOFF)
AnnaBridge 189:f392fc9709a3 605 * calculation is performed or the original register value. It provides the ability to implement a circular data
AnnaBridge 189:f392fc9709a3 606 * queue easily.
AnnaBridge 189:f392fc9709a3 607 *
AnnaBridge 189:f392fc9709a3 608 * @param tcd A pointer to the TCD structure.
AnnaBridge 189:f392fc9709a3 609 * @param srcModulo A source modulo value.
AnnaBridge 189:f392fc9709a3 610 * @param destModulo A destination modulo value.
AnnaBridge 189:f392fc9709a3 611 */
AnnaBridge 189:f392fc9709a3 612 void EDMA_TcdSetModulo(edma_tcd_t *tcd, edma_modulo_t srcModulo, edma_modulo_t destModulo);
AnnaBridge 189:f392fc9709a3 613
AnnaBridge 189:f392fc9709a3 614 /*!
AnnaBridge 189:f392fc9709a3 615 * @brief Sets the auto stop request for the eDMA TCD.
AnnaBridge 189:f392fc9709a3 616 *
AnnaBridge 189:f392fc9709a3 617 * If enabling the auto stop request, the eDMA hardware automatically disables the hardware channel request.
AnnaBridge 189:f392fc9709a3 618 *
AnnaBridge 189:f392fc9709a3 619 * @param tcd A pointer to the TCD structure.
AnnaBridge 189:f392fc9709a3 620 * @param enable The command to enable (true) or disable (false).
AnnaBridge 189:f392fc9709a3 621 */
AnnaBridge 189:f392fc9709a3 622 static inline void EDMA_TcdEnableAutoStopRequest(edma_tcd_t *tcd, bool enable)
AnnaBridge 189:f392fc9709a3 623 {
AnnaBridge 189:f392fc9709a3 624 assert(tcd != NULL);
AnnaBridge 189:f392fc9709a3 625 assert(((uint32_t)tcd & 0x1FU) == 0);
AnnaBridge 189:f392fc9709a3 626
AnnaBridge 189:f392fc9709a3 627 tcd->CSR = (tcd->CSR & (~DMA_CSR_DREQ_MASK)) | DMA_CSR_DREQ(enable);
AnnaBridge 189:f392fc9709a3 628 }
AnnaBridge 189:f392fc9709a3 629
AnnaBridge 189:f392fc9709a3 630 /*!
AnnaBridge 189:f392fc9709a3 631 * @brief Enables the interrupt source for the eDMA TCD.
AnnaBridge 189:f392fc9709a3 632 *
AnnaBridge 189:f392fc9709a3 633 * @param tcd Point to the TCD structure.
AnnaBridge 189:f392fc9709a3 634 * @param mask The mask of interrupt source to be set. Users need to use
AnnaBridge 189:f392fc9709a3 635 * the defined edma_interrupt_enable_t type.
AnnaBridge 189:f392fc9709a3 636 */
AnnaBridge 189:f392fc9709a3 637 void EDMA_TcdEnableInterrupts(edma_tcd_t *tcd, uint32_t mask);
AnnaBridge 189:f392fc9709a3 638
AnnaBridge 189:f392fc9709a3 639 /*!
AnnaBridge 189:f392fc9709a3 640 * @brief Disables the interrupt source for the eDMA TCD.
AnnaBridge 189:f392fc9709a3 641 *
AnnaBridge 189:f392fc9709a3 642 * @param tcd Point to the TCD structure.
AnnaBridge 189:f392fc9709a3 643 * @param mask The mask of interrupt source to be set. Users need to use
AnnaBridge 189:f392fc9709a3 644 * the defined edma_interrupt_enable_t type.
AnnaBridge 189:f392fc9709a3 645 */
AnnaBridge 189:f392fc9709a3 646 void EDMA_TcdDisableInterrupts(edma_tcd_t *tcd, uint32_t mask);
AnnaBridge 189:f392fc9709a3 647
AnnaBridge 189:f392fc9709a3 648 /*! @} */
AnnaBridge 189:f392fc9709a3 649 /*!
AnnaBridge 189:f392fc9709a3 650 * @name eDMA Channel Transfer Operation
AnnaBridge 189:f392fc9709a3 651 * @{
AnnaBridge 189:f392fc9709a3 652 */
AnnaBridge 189:f392fc9709a3 653
AnnaBridge 189:f392fc9709a3 654 /*!
AnnaBridge 189:f392fc9709a3 655 * @brief Enables the eDMA hardware channel request.
AnnaBridge 189:f392fc9709a3 656 *
AnnaBridge 189:f392fc9709a3 657 * This function enables the hardware channel request.
AnnaBridge 189:f392fc9709a3 658 *
AnnaBridge 189:f392fc9709a3 659 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 660 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 661 */
AnnaBridge 189:f392fc9709a3 662 static inline void EDMA_EnableChannelRequest(DMA_Type *base, uint32_t channel)
AnnaBridge 189:f392fc9709a3 663 {
AnnaBridge 189:f392fc9709a3 664 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 665
AnnaBridge 189:f392fc9709a3 666 base->SERQ = DMA_SERQ_SERQ(channel);
AnnaBridge 189:f392fc9709a3 667 }
AnnaBridge 189:f392fc9709a3 668
AnnaBridge 189:f392fc9709a3 669 /*!
AnnaBridge 189:f392fc9709a3 670 * @brief Disables the eDMA hardware channel request.
AnnaBridge 189:f392fc9709a3 671 *
AnnaBridge 189:f392fc9709a3 672 * This function disables the hardware channel request.
AnnaBridge 189:f392fc9709a3 673 *
AnnaBridge 189:f392fc9709a3 674 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 675 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 676 */
AnnaBridge 189:f392fc9709a3 677 static inline void EDMA_DisableChannelRequest(DMA_Type *base, uint32_t channel)
AnnaBridge 189:f392fc9709a3 678 {
AnnaBridge 189:f392fc9709a3 679 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 680
AnnaBridge 189:f392fc9709a3 681 base->CERQ = DMA_CERQ_CERQ(channel);
AnnaBridge 189:f392fc9709a3 682 }
AnnaBridge 189:f392fc9709a3 683
AnnaBridge 189:f392fc9709a3 684 /*!
AnnaBridge 189:f392fc9709a3 685 * @brief Starts the eDMA transfer by using the software trigger.
AnnaBridge 189:f392fc9709a3 686 *
AnnaBridge 189:f392fc9709a3 687 * This function starts a minor loop transfer.
AnnaBridge 189:f392fc9709a3 688 *
AnnaBridge 189:f392fc9709a3 689 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 690 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 691 */
AnnaBridge 189:f392fc9709a3 692 static inline void EDMA_TriggerChannelStart(DMA_Type *base, uint32_t channel)
AnnaBridge 189:f392fc9709a3 693 {
AnnaBridge 189:f392fc9709a3 694 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 695
AnnaBridge 189:f392fc9709a3 696 base->SSRT = DMA_SSRT_SSRT(channel);
AnnaBridge 189:f392fc9709a3 697 }
AnnaBridge 189:f392fc9709a3 698
AnnaBridge 189:f392fc9709a3 699 /*! @} */
AnnaBridge 189:f392fc9709a3 700 /*!
AnnaBridge 189:f392fc9709a3 701 * @name eDMA Channel Status Operation
AnnaBridge 189:f392fc9709a3 702 * @{
AnnaBridge 189:f392fc9709a3 703 */
AnnaBridge 189:f392fc9709a3 704
AnnaBridge 189:f392fc9709a3 705 /*!
AnnaBridge 189:f392fc9709a3 706 * @brief Gets the remaining major loop count from the eDMA current channel TCD.
AnnaBridge 189:f392fc9709a3 707 *
AnnaBridge 189:f392fc9709a3 708 * This function checks the TCD (Task Control Descriptor) status for a specified
AnnaBridge 189:f392fc9709a3 709 * eDMA channel and returns the the number of major loop count that has not finished.
AnnaBridge 189:f392fc9709a3 710 *
AnnaBridge 189:f392fc9709a3 711 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 712 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 713 * @return Major loop count which has not been transferred yet for the current TCD.
AnnaBridge 189:f392fc9709a3 714 * @note 1. This function can only be used to get unfinished major loop count of transfer without
AnnaBridge 189:f392fc9709a3 715 * the next TCD, or it might be inaccuracy.
AnnaBridge 189:f392fc9709a3 716 * 2. The unfinished/remaining transfer bytes cannot be obtained directly from registers while
AnnaBridge 189:f392fc9709a3 717 * the channel is running.
AnnaBridge 189:f392fc9709a3 718 * Because to calculate the remaining bytes, the initial NBYTES configured in DMA_TCDn_NBYTES_MLNO
AnnaBridge 189:f392fc9709a3 719 * register is needed while the eDMA IP does not support getting it while a channel is active.
AnnaBridge 189:f392fc9709a3 720 * In another word, the NBYTES value reading is always the actual (decrementing) NBYTES value the dma_engine
AnnaBridge 189:f392fc9709a3 721 * is working with while a channel is running.
AnnaBridge 189:f392fc9709a3 722 * Consequently, to get the remaining transfer bytes, a software-saved initial value of NBYTES (for example
AnnaBridge 189:f392fc9709a3 723 * copied before enabling the channel) is needed. The formula to calculate it is shown below:
AnnaBridge 189:f392fc9709a3 724 * RemainingBytes = RemainingMajorLoopCount * NBYTES(initially configured)
AnnaBridge 189:f392fc9709a3 725 */
AnnaBridge 189:f392fc9709a3 726 uint32_t EDMA_GetRemainingMajorLoopCount(DMA_Type *base, uint32_t channel);
AnnaBridge 189:f392fc9709a3 727
AnnaBridge 189:f392fc9709a3 728 /*!
AnnaBridge 189:f392fc9709a3 729 * @brief Gets the eDMA channel error status flags.
AnnaBridge 189:f392fc9709a3 730 *
AnnaBridge 189:f392fc9709a3 731 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 732 * @return The mask of error status flags. Users need to use the
AnnaBridge 189:f392fc9709a3 733 * _edma_error_status_flags type to decode the return variables.
AnnaBridge 189:f392fc9709a3 734 */
AnnaBridge 189:f392fc9709a3 735 static inline uint32_t EDMA_GetErrorStatusFlags(DMA_Type *base)
AnnaBridge 189:f392fc9709a3 736 {
AnnaBridge 189:f392fc9709a3 737 return base->ES;
AnnaBridge 189:f392fc9709a3 738 }
AnnaBridge 189:f392fc9709a3 739
AnnaBridge 189:f392fc9709a3 740 /*!
AnnaBridge 189:f392fc9709a3 741 * @brief Gets the eDMA channel status flags.
AnnaBridge 189:f392fc9709a3 742 *
AnnaBridge 189:f392fc9709a3 743 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 744 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 745 * @return The mask of channel status flags. Users need to use the
AnnaBridge 189:f392fc9709a3 746 * _edma_channel_status_flags type to decode the return variables.
AnnaBridge 189:f392fc9709a3 747 */
AnnaBridge 189:f392fc9709a3 748 uint32_t EDMA_GetChannelStatusFlags(DMA_Type *base, uint32_t channel);
AnnaBridge 189:f392fc9709a3 749
AnnaBridge 189:f392fc9709a3 750 /*!
AnnaBridge 189:f392fc9709a3 751 * @brief Clears the eDMA channel status flags.
AnnaBridge 189:f392fc9709a3 752 *
AnnaBridge 189:f392fc9709a3 753 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 754 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 755 * @param mask The mask of channel status to be cleared. Users need to use
AnnaBridge 189:f392fc9709a3 756 * the defined _edma_channel_status_flags type.
AnnaBridge 189:f392fc9709a3 757 */
AnnaBridge 189:f392fc9709a3 758 void EDMA_ClearChannelStatusFlags(DMA_Type *base, uint32_t channel, uint32_t mask);
AnnaBridge 189:f392fc9709a3 759
AnnaBridge 189:f392fc9709a3 760 /*! @} */
AnnaBridge 189:f392fc9709a3 761 /*!
AnnaBridge 189:f392fc9709a3 762 * @name eDMA Transactional Operation
AnnaBridge 189:f392fc9709a3 763 */
AnnaBridge 189:f392fc9709a3 764
AnnaBridge 189:f392fc9709a3 765 /*!
AnnaBridge 189:f392fc9709a3 766 * @brief Creates the eDMA handle.
AnnaBridge 189:f392fc9709a3 767 *
AnnaBridge 189:f392fc9709a3 768 * This function is called if using the transactional API for eDMA. This function
AnnaBridge 189:f392fc9709a3 769 * initializes the internal state of the eDMA handle.
AnnaBridge 189:f392fc9709a3 770 *
AnnaBridge 189:f392fc9709a3 771 * @param handle eDMA handle pointer. The eDMA handle stores callback function and
AnnaBridge 189:f392fc9709a3 772 * parameters.
AnnaBridge 189:f392fc9709a3 773 * @param base eDMA peripheral base address.
AnnaBridge 189:f392fc9709a3 774 * @param channel eDMA channel number.
AnnaBridge 189:f392fc9709a3 775 */
AnnaBridge 189:f392fc9709a3 776 void EDMA_CreateHandle(edma_handle_t *handle, DMA_Type *base, uint32_t channel);
AnnaBridge 189:f392fc9709a3 777
AnnaBridge 189:f392fc9709a3 778 /*!
AnnaBridge 189:f392fc9709a3 779 * @brief Installs the TCDs memory pool into the eDMA handle.
AnnaBridge 189:f392fc9709a3 780 *
AnnaBridge 189:f392fc9709a3 781 * This function is called after the EDMA_CreateHandle to use scatter/gather feature.
AnnaBridge 189:f392fc9709a3 782 *
AnnaBridge 189:f392fc9709a3 783 * @param handle eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 784 * @param tcdPool A memory pool to store TCDs. It must be 32 bytes aligned.
AnnaBridge 189:f392fc9709a3 785 * @param tcdSize The number of TCD slots.
AnnaBridge 189:f392fc9709a3 786 */
AnnaBridge 189:f392fc9709a3 787 void EDMA_InstallTCDMemory(edma_handle_t *handle, edma_tcd_t *tcdPool, uint32_t tcdSize);
AnnaBridge 189:f392fc9709a3 788
AnnaBridge 189:f392fc9709a3 789 /*!
AnnaBridge 189:f392fc9709a3 790 * @brief Installs a callback function for the eDMA transfer.
AnnaBridge 189:f392fc9709a3 791 *
AnnaBridge 189:f392fc9709a3 792 * This callback is called in the eDMA IRQ handler. Use the callback to do something after
AnnaBridge 189:f392fc9709a3 793 * the current major loop transfer completes.
AnnaBridge 189:f392fc9709a3 794 *
AnnaBridge 189:f392fc9709a3 795 * @param handle eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 796 * @param callback eDMA callback function pointer.
AnnaBridge 189:f392fc9709a3 797 * @param userData A parameter for the callback function.
AnnaBridge 189:f392fc9709a3 798 */
AnnaBridge 189:f392fc9709a3 799 void EDMA_SetCallback(edma_handle_t *handle, edma_callback callback, void *userData);
AnnaBridge 189:f392fc9709a3 800
AnnaBridge 189:f392fc9709a3 801 /*!
AnnaBridge 189:f392fc9709a3 802 * @brief Prepares the eDMA transfer structure.
AnnaBridge 189:f392fc9709a3 803 *
AnnaBridge 189:f392fc9709a3 804 * This function prepares the transfer configuration structure according to the user input.
AnnaBridge 189:f392fc9709a3 805 *
AnnaBridge 189:f392fc9709a3 806 * @param config The user configuration structure of type edma_transfer_t.
AnnaBridge 189:f392fc9709a3 807 * @param srcAddr eDMA transfer source address.
AnnaBridge 189:f392fc9709a3 808 * @param srcWidth eDMA transfer source address width(bytes).
AnnaBridge 189:f392fc9709a3 809 * @param destAddr eDMA transfer destination address.
AnnaBridge 189:f392fc9709a3 810 * @param destWidth eDMA transfer destination address width(bytes).
AnnaBridge 189:f392fc9709a3 811 * @param bytesEachRequest eDMA transfer bytes per channel request.
AnnaBridge 189:f392fc9709a3 812 * @param transferBytes eDMA transfer bytes to be transferred.
AnnaBridge 189:f392fc9709a3 813 * @param type eDMA transfer type.
AnnaBridge 189:f392fc9709a3 814 * @note The data address and the data width must be consistent. For example, if the SRC
AnnaBridge 189:f392fc9709a3 815 * is 4 bytes, the source address must be 4 bytes aligned, or it results in
AnnaBridge 189:f392fc9709a3 816 * source address error (SAE).
AnnaBridge 189:f392fc9709a3 817 */
AnnaBridge 189:f392fc9709a3 818 void EDMA_PrepareTransfer(edma_transfer_config_t *config,
AnnaBridge 189:f392fc9709a3 819 void *srcAddr,
AnnaBridge 189:f392fc9709a3 820 uint32_t srcWidth,
AnnaBridge 189:f392fc9709a3 821 void *destAddr,
AnnaBridge 189:f392fc9709a3 822 uint32_t destWidth,
AnnaBridge 189:f392fc9709a3 823 uint32_t bytesEachRequest,
AnnaBridge 189:f392fc9709a3 824 uint32_t transferBytes,
AnnaBridge 189:f392fc9709a3 825 edma_transfer_type_t type);
AnnaBridge 189:f392fc9709a3 826
AnnaBridge 189:f392fc9709a3 827 /*!
AnnaBridge 189:f392fc9709a3 828 * @brief Submits the eDMA transfer request.
AnnaBridge 189:f392fc9709a3 829 *
AnnaBridge 189:f392fc9709a3 830 * This function submits the eDMA transfer request according to the transfer configuration structure.
AnnaBridge 189:f392fc9709a3 831 * If submitting the transfer request repeatedly, this function packs an unprocessed request as
AnnaBridge 189:f392fc9709a3 832 * a TCD and enables scatter/gather feature to process it in the next time.
AnnaBridge 189:f392fc9709a3 833 *
AnnaBridge 189:f392fc9709a3 834 * @param handle eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 835 * @param config Pointer to eDMA transfer configuration structure.
AnnaBridge 189:f392fc9709a3 836 * @retval kStatus_EDMA_Success It means submit transfer request succeed.
AnnaBridge 189:f392fc9709a3 837 * @retval kStatus_EDMA_QueueFull It means TCD queue is full. Submit transfer request is not allowed.
AnnaBridge 189:f392fc9709a3 838 * @retval kStatus_EDMA_Busy It means the given channel is busy, need to submit request later.
AnnaBridge 189:f392fc9709a3 839 */
AnnaBridge 189:f392fc9709a3 840 status_t EDMA_SubmitTransfer(edma_handle_t *handle, const edma_transfer_config_t *config);
AnnaBridge 189:f392fc9709a3 841
AnnaBridge 189:f392fc9709a3 842 /*!
AnnaBridge 189:f392fc9709a3 843 * @brief eDMA starts transfer.
AnnaBridge 189:f392fc9709a3 844 *
AnnaBridge 189:f392fc9709a3 845 * This function enables the channel request. Users can call this function after submitting the transfer request
AnnaBridge 189:f392fc9709a3 846 * or before submitting the transfer request.
AnnaBridge 189:f392fc9709a3 847 *
AnnaBridge 189:f392fc9709a3 848 * @param handle eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 849 */
AnnaBridge 189:f392fc9709a3 850 void EDMA_StartTransfer(edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 851
AnnaBridge 189:f392fc9709a3 852 /*!
AnnaBridge 189:f392fc9709a3 853 * @brief eDMA stops transfer.
AnnaBridge 189:f392fc9709a3 854 *
AnnaBridge 189:f392fc9709a3 855 * This function disables the channel request to pause the transfer. Users can call EDMA_StartTransfer()
AnnaBridge 189:f392fc9709a3 856 * again to resume the transfer.
AnnaBridge 189:f392fc9709a3 857 *
AnnaBridge 189:f392fc9709a3 858 * @param handle eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 859 */
AnnaBridge 189:f392fc9709a3 860 void EDMA_StopTransfer(edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 861
AnnaBridge 189:f392fc9709a3 862 /*!
AnnaBridge 189:f392fc9709a3 863 * @brief eDMA aborts transfer.
AnnaBridge 189:f392fc9709a3 864 *
AnnaBridge 189:f392fc9709a3 865 * This function disables the channel request and clear transfer status bits.
AnnaBridge 189:f392fc9709a3 866 * Users can submit another transfer after calling this API.
AnnaBridge 189:f392fc9709a3 867 *
AnnaBridge 189:f392fc9709a3 868 * @param handle DMA handle pointer.
AnnaBridge 189:f392fc9709a3 869 */
AnnaBridge 189:f392fc9709a3 870 void EDMA_AbortTransfer(edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 871
AnnaBridge 189:f392fc9709a3 872 /*!
AnnaBridge 189:f392fc9709a3 873 * @brief eDMA IRQ handler for the current major loop transfer completion.
AnnaBridge 189:f392fc9709a3 874 *
AnnaBridge 189:f392fc9709a3 875 * This function clears the channel major interrupt flag and calls
AnnaBridge 189:f392fc9709a3 876 * the callback function if it is not NULL.
AnnaBridge 189:f392fc9709a3 877 *
AnnaBridge 189:f392fc9709a3 878 * Note:
AnnaBridge 189:f392fc9709a3 879 * For the case using TCD queue, when the major iteration count is exhausted, additional operations are performed.
AnnaBridge 189:f392fc9709a3 880 * These include the final address adjustments and reloading of the BITER field into the CITER.
AnnaBridge 189:f392fc9709a3 881 * Assertion of an optional interrupt request also occurs at this time, as does a possible fetch of a new TCD from
AnnaBridge 189:f392fc9709a3 882 * memory using the scatter/gather address pointer included in the descriptor (if scatter/gather is enabled).
AnnaBridge 189:f392fc9709a3 883 *
AnnaBridge 189:f392fc9709a3 884 * For instance, when the time interrupt of TCD[0] happens, the TCD[1] has already been loaded into the eDMA engine.
AnnaBridge 189:f392fc9709a3 885 * As sga and sga_index are calculated based on the DLAST_SGA bitfield lies in the TCD_CSR register, the sga_index
AnnaBridge 189:f392fc9709a3 886 * in this case should be 2 (DLAST_SGA of TCD[1] stores the address of TCD[2]). Thus, the "tcdUsed" updated should be
AnnaBridge 189:f392fc9709a3 887 * (tcdUsed - 2U) which indicates the number of TCDs can be loaded in the memory pool (because TCD[0] and TCD[1] have
AnnaBridge 189:f392fc9709a3 888 * been loaded into the eDMA engine at this point already.).
AnnaBridge 189:f392fc9709a3 889 *
AnnaBridge 189:f392fc9709a3 890 * For the last two continuous ISRs in a scatter/gather process, they both load the last TCD (The last ISR does not
AnnaBridge 189:f392fc9709a3 891 * load a new TCD) from the memory pool to the eDMA engine when major loop completes.
AnnaBridge 189:f392fc9709a3 892 * Therefore, ensure that the header and tcdUsed updated are identical for them.
AnnaBridge 189:f392fc9709a3 893 * tcdUsed are both 0 in this case as no TCD to be loaded.
AnnaBridge 189:f392fc9709a3 894 *
AnnaBridge 189:f392fc9709a3 895 * See the "eDMA basic data flow" in the eDMA Functional description section of the Reference Manual for
AnnaBridge 189:f392fc9709a3 896 * further details.
AnnaBridge 189:f392fc9709a3 897 *
AnnaBridge 189:f392fc9709a3 898 * @param handle eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 899 */
AnnaBridge 189:f392fc9709a3 900 void EDMA_HandleIRQ(edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 901
AnnaBridge 189:f392fc9709a3 902 /* @} */
AnnaBridge 189:f392fc9709a3 903
AnnaBridge 189:f392fc9709a3 904 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 905 }
AnnaBridge 189:f392fc9709a3 906 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 907
AnnaBridge 189:f392fc9709a3 908 /* @} */
AnnaBridge 189:f392fc9709a3 909
AnnaBridge 189:f392fc9709a3 910 #endif /*_FSL_EDMA_H_*/