Lee Kai Xuan / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-os by erkin yucel

targets/TARGET_Freescale/TARGET_KSDK2_MCUS/TARGET_MCU_K64F/drivers/fsl_dmamux.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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