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_MIMXRT1050_EVK/TOOLCHAIN_IAR/fsl_dmamux.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_MIMXRT1050_EVK/TARGET_NXP/TARGET_MCUXpresso_MCUS/TARGET_MIMXRT1050/drivers/fsl_dmamux.h@170:e95d10626187 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 161:aa5281ff4a02 1 /*
AnnaBridge 170:e95d10626187 2 * The Clear BSD License
AnnaBridge 161:aa5281ff4a02 3 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 161:aa5281ff4a02 4 * Copyright 2016-2017 NXP
AnnaBridge 170:e95d10626187 5 * All rights reserved.
AnnaBridge 170:e95d10626187 6 *
AnnaBridge 161:aa5281ff4a02 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 170:e95d10626187 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 170:e95d10626187 9 * that the following conditions are met:
AnnaBridge 161:aa5281ff4a02 10 *
AnnaBridge 161:aa5281ff4a02 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 161:aa5281ff4a02 12 * of conditions and the following disclaimer.
AnnaBridge 161:aa5281ff4a02 13 *
AnnaBridge 161:aa5281ff4a02 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 161:aa5281ff4a02 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 161:aa5281ff4a02 16 * other materials provided with the distribution.
AnnaBridge 161:aa5281ff4a02 17 *
AnnaBridge 161:aa5281ff4a02 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 161:aa5281ff4a02 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 161:aa5281ff4a02 20 * software without specific prior written permission.
AnnaBridge 161:aa5281ff4a02 21 *
AnnaBridge 170:e95d10626187 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 161:aa5281ff4a02 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 161:aa5281ff4a02 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 161:aa5281ff4a02 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 161:aa5281ff4a02 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 161:aa5281ff4a02 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 161:aa5281ff4a02 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 161:aa5281ff4a02 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 161:aa5281ff4a02 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 161:aa5281ff4a02 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 161:aa5281ff4a02 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 161:aa5281ff4a02 33 */
AnnaBridge 161:aa5281ff4a02 34
AnnaBridge 161:aa5281ff4a02 35 #ifndef _FSL_DMAMUX_H_
AnnaBridge 161:aa5281ff4a02 36 #define _FSL_DMAMUX_H_
AnnaBridge 161:aa5281ff4a02 37
AnnaBridge 161:aa5281ff4a02 38 #include "fsl_common.h"
AnnaBridge 161:aa5281ff4a02 39
AnnaBridge 161:aa5281ff4a02 40 /*!
AnnaBridge 161:aa5281ff4a02 41 * @addtogroup dmamux
AnnaBridge 161:aa5281ff4a02 42 * @{
AnnaBridge 161:aa5281ff4a02 43 */
AnnaBridge 161:aa5281ff4a02 44
AnnaBridge 161:aa5281ff4a02 45
AnnaBridge 161:aa5281ff4a02 46 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 47 * Definitions
AnnaBridge 161:aa5281ff4a02 48 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 49
AnnaBridge 161:aa5281ff4a02 50 /*! @name Driver version */
AnnaBridge 161:aa5281ff4a02 51 /*@{*/
AnnaBridge 161:aa5281ff4a02 52 /*! @brief DMAMUX driver version 2.0.2. */
AnnaBridge 161:aa5281ff4a02 53 #define FSL_DMAMUX_DRIVER_VERSION (MAKE_VERSION(2, 0, 2))
AnnaBridge 161:aa5281ff4a02 54 /*@}*/
AnnaBridge 161:aa5281ff4a02 55
AnnaBridge 161:aa5281ff4a02 56 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 57 * API
AnnaBridge 161:aa5281ff4a02 58 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 59
AnnaBridge 161:aa5281ff4a02 60 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 61 extern "C" {
AnnaBridge 161:aa5281ff4a02 62 #endif /* __cplusplus */
AnnaBridge 161:aa5281ff4a02 63
AnnaBridge 161:aa5281ff4a02 64 /*!
AnnaBridge 161:aa5281ff4a02 65 * @name DMAMUX Initialization and de-initialization
AnnaBridge 161:aa5281ff4a02 66 * @{
AnnaBridge 161:aa5281ff4a02 67 */
AnnaBridge 161:aa5281ff4a02 68
AnnaBridge 161:aa5281ff4a02 69 /*!
AnnaBridge 161:aa5281ff4a02 70 * @brief Initializes the DMAMUX peripheral.
AnnaBridge 161:aa5281ff4a02 71 *
AnnaBridge 161:aa5281ff4a02 72 * This function ungates the DMAMUX clock.
AnnaBridge 161:aa5281ff4a02 73 *
AnnaBridge 161:aa5281ff4a02 74 * @param base DMAMUX peripheral base address.
AnnaBridge 161:aa5281ff4a02 75 *
AnnaBridge 161:aa5281ff4a02 76 */
AnnaBridge 161:aa5281ff4a02 77 void DMAMUX_Init(DMAMUX_Type *base);
AnnaBridge 161:aa5281ff4a02 78
AnnaBridge 161:aa5281ff4a02 79 /*!
AnnaBridge 161:aa5281ff4a02 80 * @brief Deinitializes the DMAMUX peripheral.
AnnaBridge 161:aa5281ff4a02 81 *
AnnaBridge 161:aa5281ff4a02 82 * This function gates the DMAMUX clock.
AnnaBridge 161:aa5281ff4a02 83 *
AnnaBridge 161:aa5281ff4a02 84 * @param base DMAMUX peripheral base address.
AnnaBridge 161:aa5281ff4a02 85 */
AnnaBridge 161:aa5281ff4a02 86 void DMAMUX_Deinit(DMAMUX_Type *base);
AnnaBridge 161:aa5281ff4a02 87
AnnaBridge 161:aa5281ff4a02 88 /* @} */
AnnaBridge 161:aa5281ff4a02 89 /*!
AnnaBridge 161:aa5281ff4a02 90 * @name DMAMUX Channel Operation
AnnaBridge 161:aa5281ff4a02 91 * @{
AnnaBridge 161:aa5281ff4a02 92 */
AnnaBridge 161:aa5281ff4a02 93
AnnaBridge 161:aa5281ff4a02 94 /*!
AnnaBridge 161:aa5281ff4a02 95 * @brief Enables the DMAMUX channel.
AnnaBridge 161:aa5281ff4a02 96 *
AnnaBridge 161:aa5281ff4a02 97 * This function enables the DMAMUX channel.
AnnaBridge 161:aa5281ff4a02 98 *
AnnaBridge 161:aa5281ff4a02 99 * @param base DMAMUX peripheral base address.
AnnaBridge 161:aa5281ff4a02 100 * @param channel DMAMUX channel number.
AnnaBridge 161:aa5281ff4a02 101 */
AnnaBridge 161:aa5281ff4a02 102 static inline void DMAMUX_EnableChannel(DMAMUX_Type *base, uint32_t channel)
AnnaBridge 161:aa5281ff4a02 103 {
AnnaBridge 161:aa5281ff4a02 104 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 161:aa5281ff4a02 105
AnnaBridge 161:aa5281ff4a02 106 base->CHCFG[channel] |= DMAMUX_CHCFG_ENBL_MASK;
AnnaBridge 161:aa5281ff4a02 107 }
AnnaBridge 161:aa5281ff4a02 108
AnnaBridge 161:aa5281ff4a02 109 /*!
AnnaBridge 161:aa5281ff4a02 110 * @brief Disables the DMAMUX channel.
AnnaBridge 161:aa5281ff4a02 111 *
AnnaBridge 161:aa5281ff4a02 112 * This function disables the DMAMUX channel.
AnnaBridge 161:aa5281ff4a02 113 *
AnnaBridge 161:aa5281ff4a02 114 * @note The user must disable the DMAMUX channel before configuring it.
AnnaBridge 161:aa5281ff4a02 115 * @param base DMAMUX peripheral base address.
AnnaBridge 161:aa5281ff4a02 116 * @param channel DMAMUX channel number.
AnnaBridge 161:aa5281ff4a02 117 */
AnnaBridge 161:aa5281ff4a02 118 static inline void DMAMUX_DisableChannel(DMAMUX_Type *base, uint32_t channel)
AnnaBridge 161:aa5281ff4a02 119 {
AnnaBridge 161:aa5281ff4a02 120 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 161:aa5281ff4a02 121
AnnaBridge 161:aa5281ff4a02 122 base->CHCFG[channel] &= ~DMAMUX_CHCFG_ENBL_MASK;
AnnaBridge 161:aa5281ff4a02 123 }
AnnaBridge 161:aa5281ff4a02 124
AnnaBridge 161:aa5281ff4a02 125 /*!
AnnaBridge 161:aa5281ff4a02 126 * @brief Configures the DMAMUX channel source.
AnnaBridge 161:aa5281ff4a02 127 *
AnnaBridge 161:aa5281ff4a02 128 * @param base DMAMUX peripheral base address.
AnnaBridge 161:aa5281ff4a02 129 * @param channel DMAMUX channel number.
AnnaBridge 161:aa5281ff4a02 130 * @param source Channel source, which is used to trigger the DMA transfer.
AnnaBridge 161:aa5281ff4a02 131 */
AnnaBridge 161:aa5281ff4a02 132 static inline void DMAMUX_SetSource(DMAMUX_Type *base, uint32_t channel, uint32_t source)
AnnaBridge 161:aa5281ff4a02 133 {
AnnaBridge 161:aa5281ff4a02 134 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 161:aa5281ff4a02 135
AnnaBridge 161:aa5281ff4a02 136 base->CHCFG[channel] = ((base->CHCFG[channel] & ~DMAMUX_CHCFG_SOURCE_MASK) | DMAMUX_CHCFG_SOURCE(source));
AnnaBridge 161:aa5281ff4a02 137 }
AnnaBridge 161:aa5281ff4a02 138
AnnaBridge 161:aa5281ff4a02 139 #if defined(FSL_FEATURE_DMAMUX_HAS_TRIG) && FSL_FEATURE_DMAMUX_HAS_TRIG > 0U
AnnaBridge 161:aa5281ff4a02 140 /*!
AnnaBridge 161:aa5281ff4a02 141 * @brief Enables the DMAMUX period trigger.
AnnaBridge 161:aa5281ff4a02 142 *
AnnaBridge 161:aa5281ff4a02 143 * This function enables the DMAMUX period trigger feature.
AnnaBridge 161:aa5281ff4a02 144 *
AnnaBridge 161:aa5281ff4a02 145 * @param base DMAMUX peripheral base address.
AnnaBridge 161:aa5281ff4a02 146 * @param channel DMAMUX channel number.
AnnaBridge 161:aa5281ff4a02 147 */
AnnaBridge 161:aa5281ff4a02 148 static inline void DMAMUX_EnablePeriodTrigger(DMAMUX_Type *base, uint32_t channel)
AnnaBridge 161:aa5281ff4a02 149 {
AnnaBridge 161:aa5281ff4a02 150 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 161:aa5281ff4a02 151
AnnaBridge 161:aa5281ff4a02 152 base->CHCFG[channel] |= DMAMUX_CHCFG_TRIG_MASK;
AnnaBridge 161:aa5281ff4a02 153 }
AnnaBridge 161:aa5281ff4a02 154
AnnaBridge 161:aa5281ff4a02 155 /*!
AnnaBridge 161:aa5281ff4a02 156 * @brief Disables the DMAMUX period trigger.
AnnaBridge 161:aa5281ff4a02 157 *
AnnaBridge 161:aa5281ff4a02 158 * This function disables the DMAMUX period trigger.
AnnaBridge 161:aa5281ff4a02 159 *
AnnaBridge 161:aa5281ff4a02 160 * @param base DMAMUX peripheral base address.
AnnaBridge 161:aa5281ff4a02 161 * @param channel DMAMUX channel number.
AnnaBridge 161:aa5281ff4a02 162 */
AnnaBridge 161:aa5281ff4a02 163 static inline void DMAMUX_DisablePeriodTrigger(DMAMUX_Type *base, uint32_t channel)
AnnaBridge 161:aa5281ff4a02 164 {
AnnaBridge 161:aa5281ff4a02 165 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 161:aa5281ff4a02 166
AnnaBridge 161:aa5281ff4a02 167 base->CHCFG[channel] &= ~DMAMUX_CHCFG_TRIG_MASK;
AnnaBridge 161:aa5281ff4a02 168 }
AnnaBridge 161:aa5281ff4a02 169 #endif /* FSL_FEATURE_DMAMUX_HAS_TRIG */
AnnaBridge 161:aa5281ff4a02 170
AnnaBridge 161:aa5281ff4a02 171 #if (defined(FSL_FEATURE_DMAMUX_HAS_A_ON) && FSL_FEATURE_DMAMUX_HAS_A_ON)
AnnaBridge 161:aa5281ff4a02 172 /*!
AnnaBridge 161:aa5281ff4a02 173 * @brief Enables the DMA channel to be always ON.
AnnaBridge 161:aa5281ff4a02 174 *
AnnaBridge 161:aa5281ff4a02 175 * This function enables the DMAMUX channel always ON feature.
AnnaBridge 161:aa5281ff4a02 176 *
AnnaBridge 161:aa5281ff4a02 177 * @param base DMAMUX peripheral base address.
AnnaBridge 161:aa5281ff4a02 178 * @param channel DMAMUX channel number.
AnnaBridge 161:aa5281ff4a02 179 * @param enable Switcher of the always ON feature. "true" means enabled, "false" means disabled.
AnnaBridge 161:aa5281ff4a02 180 */
AnnaBridge 161:aa5281ff4a02 181 static inline void DMAMUX_EnableAlwaysOn(DMAMUX_Type *base, uint32_t channel, bool enable)
AnnaBridge 161:aa5281ff4a02 182 {
AnnaBridge 161:aa5281ff4a02 183 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 161:aa5281ff4a02 184
AnnaBridge 161:aa5281ff4a02 185 if (enable)
AnnaBridge 161:aa5281ff4a02 186 {
AnnaBridge 161:aa5281ff4a02 187 base->CHCFG[channel] |= DMAMUX_CHCFG_A_ON_MASK;
AnnaBridge 161:aa5281ff4a02 188 }
AnnaBridge 161:aa5281ff4a02 189 else
AnnaBridge 161:aa5281ff4a02 190 {
AnnaBridge 161:aa5281ff4a02 191 base->CHCFG[channel] &= ~DMAMUX_CHCFG_A_ON_MASK;
AnnaBridge 161:aa5281ff4a02 192 }
AnnaBridge 161:aa5281ff4a02 193 }
AnnaBridge 161:aa5281ff4a02 194 #endif /* FSL_FEATURE_DMAMUX_HAS_A_ON */
AnnaBridge 161:aa5281ff4a02 195
AnnaBridge 161:aa5281ff4a02 196 /* @} */
AnnaBridge 161:aa5281ff4a02 197
AnnaBridge 161:aa5281ff4a02 198 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 199 }
AnnaBridge 161:aa5281ff4a02 200 #endif /* __cplusplus */
AnnaBridge 161:aa5281ff4a02 201
AnnaBridge 161:aa5281ff4a02 202 /* @} */
AnnaBridge 161:aa5281ff4a02 203
AnnaBridge 161:aa5281ff4a02 204 #endif /* _FSL_DMAMUX_H_ */