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_dmamux.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_DMAMUX_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_DMAMUX_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 dmamux
AnnaBridge 189:f392fc9709a3 38 * @{
AnnaBridge 189:f392fc9709a3 39 */
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41
AnnaBridge 189:f392fc9709a3 42 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 43 * Definitions
AnnaBridge 189:f392fc9709a3 44 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 45
AnnaBridge 189:f392fc9709a3 46 /*! @name Driver version */
AnnaBridge 189:f392fc9709a3 47 /*@{*/
AnnaBridge 189:f392fc9709a3 48 /*! @brief DMAMUX driver version 2.0.2. */
AnnaBridge 189:f392fc9709a3 49 #define FSL_DMAMUX_DRIVER_VERSION (MAKE_VERSION(2, 0, 2))
AnnaBridge 189:f392fc9709a3 50 /*@}*/
AnnaBridge 189:f392fc9709a3 51
AnnaBridge 189:f392fc9709a3 52 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 53 * API
AnnaBridge 189:f392fc9709a3 54 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 55
AnnaBridge 189:f392fc9709a3 56 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 57 extern "C" {
AnnaBridge 189:f392fc9709a3 58 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 59
AnnaBridge 189:f392fc9709a3 60 /*!
AnnaBridge 189:f392fc9709a3 61 * @name DMAMUX Initialization and de-initialization
AnnaBridge 189:f392fc9709a3 62 * @{
AnnaBridge 189:f392fc9709a3 63 */
AnnaBridge 189:f392fc9709a3 64
AnnaBridge 189:f392fc9709a3 65 /*!
AnnaBridge 189:f392fc9709a3 66 * @brief Initializes the DMAMUX peripheral.
AnnaBridge 189:f392fc9709a3 67 *
AnnaBridge 189:f392fc9709a3 68 * This function ungates the DMAMUX clock.
AnnaBridge 189:f392fc9709a3 69 *
AnnaBridge 189:f392fc9709a3 70 * @param base DMAMUX peripheral base address.
AnnaBridge 189:f392fc9709a3 71 *
AnnaBridge 189:f392fc9709a3 72 */
AnnaBridge 189:f392fc9709a3 73 void DMAMUX_Init(DMAMUX_Type *base);
AnnaBridge 189:f392fc9709a3 74
AnnaBridge 189:f392fc9709a3 75 /*!
AnnaBridge 189:f392fc9709a3 76 * @brief Deinitializes the DMAMUX peripheral.
AnnaBridge 189:f392fc9709a3 77 *
AnnaBridge 189:f392fc9709a3 78 * This function gates the DMAMUX clock.
AnnaBridge 189:f392fc9709a3 79 *
AnnaBridge 189:f392fc9709a3 80 * @param base DMAMUX peripheral base address.
AnnaBridge 189:f392fc9709a3 81 */
AnnaBridge 189:f392fc9709a3 82 void DMAMUX_Deinit(DMAMUX_Type *base);
AnnaBridge 189:f392fc9709a3 83
AnnaBridge 189:f392fc9709a3 84 /* @} */
AnnaBridge 189:f392fc9709a3 85 /*!
AnnaBridge 189:f392fc9709a3 86 * @name DMAMUX Channel Operation
AnnaBridge 189:f392fc9709a3 87 * @{
AnnaBridge 189:f392fc9709a3 88 */
AnnaBridge 189:f392fc9709a3 89
AnnaBridge 189:f392fc9709a3 90 /*!
AnnaBridge 189:f392fc9709a3 91 * @brief Enables the DMAMUX channel.
AnnaBridge 189:f392fc9709a3 92 *
AnnaBridge 189:f392fc9709a3 93 * This function enables the DMAMUX channel.
AnnaBridge 189:f392fc9709a3 94 *
AnnaBridge 189:f392fc9709a3 95 * @param base DMAMUX peripheral base address.
AnnaBridge 189:f392fc9709a3 96 * @param channel DMAMUX channel number.
AnnaBridge 189:f392fc9709a3 97 */
AnnaBridge 189:f392fc9709a3 98 static inline void DMAMUX_EnableChannel(DMAMUX_Type *base, uint32_t channel)
AnnaBridge 189:f392fc9709a3 99 {
AnnaBridge 189:f392fc9709a3 100 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 101
AnnaBridge 189:f392fc9709a3 102 base->CHCFG[channel] |= DMAMUX_CHCFG_ENBL_MASK;
AnnaBridge 189:f392fc9709a3 103 }
AnnaBridge 189:f392fc9709a3 104
AnnaBridge 189:f392fc9709a3 105 /*!
AnnaBridge 189:f392fc9709a3 106 * @brief Disables the DMAMUX channel.
AnnaBridge 189:f392fc9709a3 107 *
AnnaBridge 189:f392fc9709a3 108 * This function disables the DMAMUX channel.
AnnaBridge 189:f392fc9709a3 109 *
AnnaBridge 189:f392fc9709a3 110 * @note The user must disable the DMAMUX channel before configuring it.
AnnaBridge 189:f392fc9709a3 111 * @param base DMAMUX peripheral base address.
AnnaBridge 189:f392fc9709a3 112 * @param channel DMAMUX channel number.
AnnaBridge 189:f392fc9709a3 113 */
AnnaBridge 189:f392fc9709a3 114 static inline void DMAMUX_DisableChannel(DMAMUX_Type *base, uint32_t channel)
AnnaBridge 189:f392fc9709a3 115 {
AnnaBridge 189:f392fc9709a3 116 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 117
AnnaBridge 189:f392fc9709a3 118 base->CHCFG[channel] &= ~DMAMUX_CHCFG_ENBL_MASK;
AnnaBridge 189:f392fc9709a3 119 }
AnnaBridge 189:f392fc9709a3 120
AnnaBridge 189:f392fc9709a3 121 /*!
AnnaBridge 189:f392fc9709a3 122 * @brief Configures the DMAMUX channel source.
AnnaBridge 189:f392fc9709a3 123 *
AnnaBridge 189:f392fc9709a3 124 * @param base DMAMUX peripheral base address.
AnnaBridge 189:f392fc9709a3 125 * @param channel DMAMUX channel number.
AnnaBridge 189:f392fc9709a3 126 * @param source Channel source, which is used to trigger the DMA transfer.
AnnaBridge 189:f392fc9709a3 127 */
AnnaBridge 189:f392fc9709a3 128 static inline void DMAMUX_SetSource(DMAMUX_Type *base, uint32_t channel, uint32_t source)
AnnaBridge 189:f392fc9709a3 129 {
AnnaBridge 189:f392fc9709a3 130 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 131
AnnaBridge 189:f392fc9709a3 132 base->CHCFG[channel] = ((base->CHCFG[channel] & ~DMAMUX_CHCFG_SOURCE_MASK) | DMAMUX_CHCFG_SOURCE(source));
AnnaBridge 189:f392fc9709a3 133 }
AnnaBridge 189:f392fc9709a3 134
AnnaBridge 189:f392fc9709a3 135 #if defined(FSL_FEATURE_DMAMUX_HAS_TRIG) && FSL_FEATURE_DMAMUX_HAS_TRIG > 0U
AnnaBridge 189:f392fc9709a3 136 /*!
AnnaBridge 189:f392fc9709a3 137 * @brief Enables the DMAMUX period trigger.
AnnaBridge 189:f392fc9709a3 138 *
AnnaBridge 189:f392fc9709a3 139 * This function enables the DMAMUX period trigger feature.
AnnaBridge 189:f392fc9709a3 140 *
AnnaBridge 189:f392fc9709a3 141 * @param base DMAMUX peripheral base address.
AnnaBridge 189:f392fc9709a3 142 * @param channel DMAMUX channel number.
AnnaBridge 189:f392fc9709a3 143 */
AnnaBridge 189:f392fc9709a3 144 static inline void DMAMUX_EnablePeriodTrigger(DMAMUX_Type *base, uint32_t channel)
AnnaBridge 189:f392fc9709a3 145 {
AnnaBridge 189:f392fc9709a3 146 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 147
AnnaBridge 189:f392fc9709a3 148 base->CHCFG[channel] |= DMAMUX_CHCFG_TRIG_MASK;
AnnaBridge 189:f392fc9709a3 149 }
AnnaBridge 189:f392fc9709a3 150
AnnaBridge 189:f392fc9709a3 151 /*!
AnnaBridge 189:f392fc9709a3 152 * @brief Disables the DMAMUX period trigger.
AnnaBridge 189:f392fc9709a3 153 *
AnnaBridge 189:f392fc9709a3 154 * This function disables the DMAMUX period trigger.
AnnaBridge 189:f392fc9709a3 155 *
AnnaBridge 189:f392fc9709a3 156 * @param base DMAMUX peripheral base address.
AnnaBridge 189:f392fc9709a3 157 * @param channel DMAMUX channel number.
AnnaBridge 189:f392fc9709a3 158 */
AnnaBridge 189:f392fc9709a3 159 static inline void DMAMUX_DisablePeriodTrigger(DMAMUX_Type *base, uint32_t channel)
AnnaBridge 189:f392fc9709a3 160 {
AnnaBridge 189:f392fc9709a3 161 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 162
AnnaBridge 189:f392fc9709a3 163 base->CHCFG[channel] &= ~DMAMUX_CHCFG_TRIG_MASK;
AnnaBridge 189:f392fc9709a3 164 }
AnnaBridge 189:f392fc9709a3 165 #endif /* FSL_FEATURE_DMAMUX_HAS_TRIG */
AnnaBridge 189:f392fc9709a3 166
AnnaBridge 189:f392fc9709a3 167 #if (defined(FSL_FEATURE_DMAMUX_HAS_A_ON) && FSL_FEATURE_DMAMUX_HAS_A_ON)
AnnaBridge 189:f392fc9709a3 168 /*!
AnnaBridge 189:f392fc9709a3 169 * @brief Enables the DMA channel to be always ON.
AnnaBridge 189:f392fc9709a3 170 *
AnnaBridge 189:f392fc9709a3 171 * This function enables the DMAMUX channel always ON feature.
AnnaBridge 189:f392fc9709a3 172 *
AnnaBridge 189:f392fc9709a3 173 * @param base DMAMUX peripheral base address.
AnnaBridge 189:f392fc9709a3 174 * @param channel DMAMUX channel number.
AnnaBridge 189:f392fc9709a3 175 * @param enable Switcher of the always ON feature. "true" means enabled, "false" means disabled.
AnnaBridge 189:f392fc9709a3 176 */
AnnaBridge 189:f392fc9709a3 177 static inline void DMAMUX_EnableAlwaysOn(DMAMUX_Type *base, uint32_t channel, bool enable)
AnnaBridge 189:f392fc9709a3 178 {
AnnaBridge 189:f392fc9709a3 179 assert(channel < FSL_FEATURE_DMAMUX_MODULE_CHANNEL);
AnnaBridge 189:f392fc9709a3 180
AnnaBridge 189:f392fc9709a3 181 if (enable)
AnnaBridge 189:f392fc9709a3 182 {
AnnaBridge 189:f392fc9709a3 183 base->CHCFG[channel] |= DMAMUX_CHCFG_A_ON_MASK;
AnnaBridge 189:f392fc9709a3 184 }
AnnaBridge 189:f392fc9709a3 185 else
AnnaBridge 189:f392fc9709a3 186 {
AnnaBridge 189:f392fc9709a3 187 base->CHCFG[channel] &= ~DMAMUX_CHCFG_A_ON_MASK;
AnnaBridge 189:f392fc9709a3 188 }
AnnaBridge 189:f392fc9709a3 189 }
AnnaBridge 189:f392fc9709a3 190 #endif /* FSL_FEATURE_DMAMUX_HAS_A_ON */
AnnaBridge 189:f392fc9709a3 191
AnnaBridge 189:f392fc9709a3 192 /* @} */
AnnaBridge 189:f392fc9709a3 193
AnnaBridge 189:f392fc9709a3 194 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 195 }
AnnaBridge 189:f392fc9709a3 196 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 197
AnnaBridge 189:f392fc9709a3 198 /* @} */
AnnaBridge 189:f392fc9709a3 199
AnnaBridge 189:f392fc9709a3 200 #endif /* _FSL_DMAMUX_H_ */