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_RO359B/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_RO359B/TARGET_Freescale/TARGET_MCUXpresso_MCUS/TARGET_MCU_K24F/drivers/fsl_dmamux.h@143:86740a56073b 
mbed library. Release version 164

Who changed what in which revision?

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