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_K22F/TOOLCHAIN_GCC_ARM/fsl_ewm.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /*
AnnaBridge 171:3a7713b1edbc 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 171:3a7713b1edbc 3 * All rights reserved.
AnnaBridge 171:3a7713b1edbc 4 *
AnnaBridge 171:3a7713b1edbc 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 171:3a7713b1edbc 6 * are permitted provided that the following conditions are met:
AnnaBridge 171:3a7713b1edbc 7 *
AnnaBridge 171:3a7713b1edbc 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 171:3a7713b1edbc 9 * of conditions and the following disclaimer.
AnnaBridge 171:3a7713b1edbc 10 *
AnnaBridge 171:3a7713b1edbc 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 171:3a7713b1edbc 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 171:3a7713b1edbc 13 * other materials provided with the distribution.
AnnaBridge 171:3a7713b1edbc 14 *
AnnaBridge 171:3a7713b1edbc 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 171:3a7713b1edbc 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 171:3a7713b1edbc 17 * software without specific prior written permission.
AnnaBridge 171:3a7713b1edbc 18 *
AnnaBridge 171:3a7713b1edbc 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 171:3a7713b1edbc 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 171:3a7713b1edbc 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 171:3a7713b1edbc 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 171:3a7713b1edbc 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 171:3a7713b1edbc 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 171:3a7713b1edbc 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 171:3a7713b1edbc 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 171:3a7713b1edbc 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 171:3a7713b1edbc 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 171:3a7713b1edbc 29 */
AnnaBridge 171:3a7713b1edbc 30 #ifndef _FSL_EWM_H_
AnnaBridge 171:3a7713b1edbc 31 #define _FSL_EWM_H_
AnnaBridge 171:3a7713b1edbc 32
AnnaBridge 171:3a7713b1edbc 33 #include "fsl_common.h"
AnnaBridge 171:3a7713b1edbc 34
AnnaBridge 171:3a7713b1edbc 35 /*!
AnnaBridge 171:3a7713b1edbc 36 * @addtogroup ewm_driver
AnnaBridge 171:3a7713b1edbc 37 * @{
AnnaBridge 171:3a7713b1edbc 38 */
AnnaBridge 171:3a7713b1edbc 39
AnnaBridge 171:3a7713b1edbc 40 /*! @file */
AnnaBridge 171:3a7713b1edbc 41
AnnaBridge 171:3a7713b1edbc 42 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 43 * Definitions
AnnaBridge 171:3a7713b1edbc 44 *******************************************************************************/
AnnaBridge 171:3a7713b1edbc 45
AnnaBridge 171:3a7713b1edbc 46 /*! @name Driver version */
AnnaBridge 171:3a7713b1edbc 47 /*@{*/
AnnaBridge 171:3a7713b1edbc 48 /*! @brief EWM driver version 2.0.1. */
AnnaBridge 171:3a7713b1edbc 49 #define FSL_EWM_DRIVER_VERSION (MAKE_VERSION(2, 0, 1))
AnnaBridge 171:3a7713b1edbc 50 /*@}*/
AnnaBridge 171:3a7713b1edbc 51
AnnaBridge 171:3a7713b1edbc 52 /*! @brief Describes ewm clock source. */
AnnaBridge 171:3a7713b1edbc 53 #if defined(FSL_FEATURE_EWM_HAS_CLOCK_SELECT) && FSL_FEATURE_EWM_HAS_CLOCK_SELECT
AnnaBridge 171:3a7713b1edbc 54 typedef enum _ewm_lpo_clock_source
AnnaBridge 171:3a7713b1edbc 55 {
AnnaBridge 171:3a7713b1edbc 56 kEWM_LpoClockSource0 = 0U, /*!< ewm clock sourced from lpo_clk[0]*/
AnnaBridge 171:3a7713b1edbc 57 kEWM_LpoClockSource1 = 1U, /*!< ewm clock sourced from lpo_clk[1]*/
AnnaBridge 171:3a7713b1edbc 58 kEWM_LpoClockSource2 = 2U, /*!< ewm clock sourced from lpo_clk[2]*/
AnnaBridge 171:3a7713b1edbc 59 kEWM_LpoClockSource3 = 3U, /*!< ewm clock sourced from lpo_clk[3]*/
AnnaBridge 171:3a7713b1edbc 60 } ewm_lpo_clock_source_t;
AnnaBridge 171:3a7713b1edbc 61 #endif /* FSL_FEATURE_EWM_HAS_CLOCK_SELECT */
AnnaBridge 171:3a7713b1edbc 62
AnnaBridge 171:3a7713b1edbc 63 /*!
AnnaBridge 171:3a7713b1edbc 64 * @brief Data structure for EWM configuration.
AnnaBridge 171:3a7713b1edbc 65 *
AnnaBridge 171:3a7713b1edbc 66 * This structure is used to configure the EWM.
AnnaBridge 171:3a7713b1edbc 67 */
AnnaBridge 171:3a7713b1edbc 68 typedef struct _ewm_config
AnnaBridge 171:3a7713b1edbc 69 {
AnnaBridge 171:3a7713b1edbc 70 bool enableEwm; /*!< Enable EWM module */
AnnaBridge 171:3a7713b1edbc 71 bool enableEwmInput; /*!< Enable EWM_in input */
AnnaBridge 171:3a7713b1edbc 72 bool setInputAssertLogic; /*!< EWM_in signal assertion state */
AnnaBridge 171:3a7713b1edbc 73 bool enableInterrupt; /*!< Enable EWM interrupt */
AnnaBridge 171:3a7713b1edbc 74 #if defined(FSL_FEATURE_EWM_HAS_CLOCK_SELECT) && FSL_FEATURE_EWM_HAS_CLOCK_SELECT
AnnaBridge 171:3a7713b1edbc 75 ewm_lpo_clock_source_t clockSource; /*!< Clock source select */
AnnaBridge 171:3a7713b1edbc 76 #endif /* FSL_FEATURE_EWM_HAS_CLOCK_SELECT */
AnnaBridge 171:3a7713b1edbc 77 #if defined(FSL_FEATURE_EWM_HAS_PRESCALER) && FSL_FEATURE_EWM_HAS_PRESCALER
AnnaBridge 171:3a7713b1edbc 78 uint8_t prescaler; /*!< Clock prescaler value */
AnnaBridge 171:3a7713b1edbc 79 #endif /* FSL_FEATURE_EWM_HAS_PRESCALER */
AnnaBridge 171:3a7713b1edbc 80 uint8_t compareLowValue; /*!< Compare low register value */
AnnaBridge 171:3a7713b1edbc 81 uint8_t compareHighValue; /*!< Compare high register value */
AnnaBridge 171:3a7713b1edbc 82 } ewm_config_t;
AnnaBridge 171:3a7713b1edbc 83
AnnaBridge 171:3a7713b1edbc 84 /*!
AnnaBridge 171:3a7713b1edbc 85 * @brief EWM interrupt configuration structure, default settings all disabled.
AnnaBridge 171:3a7713b1edbc 86 *
AnnaBridge 171:3a7713b1edbc 87 * This structure contains the settings for all of the EWM interrupt configurations.
AnnaBridge 171:3a7713b1edbc 88 */
AnnaBridge 171:3a7713b1edbc 89 enum _ewm_interrupt_enable_t
AnnaBridge 171:3a7713b1edbc 90 {
AnnaBridge 171:3a7713b1edbc 91 kEWM_InterruptEnable = EWM_CTRL_INTEN_MASK, /*!< Enable EWM to generate an interrupt*/
AnnaBridge 171:3a7713b1edbc 92 };
AnnaBridge 171:3a7713b1edbc 93
AnnaBridge 171:3a7713b1edbc 94 /*!
AnnaBridge 171:3a7713b1edbc 95 * @brief EWM status flags.
AnnaBridge 171:3a7713b1edbc 96 *
AnnaBridge 171:3a7713b1edbc 97 * This structure contains the constants for the EWM status flags for use in the EWM functions.
AnnaBridge 171:3a7713b1edbc 98 */
AnnaBridge 171:3a7713b1edbc 99 enum _ewm_status_flags_t
AnnaBridge 171:3a7713b1edbc 100 {
AnnaBridge 171:3a7713b1edbc 101 kEWM_RunningFlag = EWM_CTRL_EWMEN_MASK, /*!< Running flag, set when ewm is enabled*/
AnnaBridge 171:3a7713b1edbc 102 };
AnnaBridge 171:3a7713b1edbc 103
AnnaBridge 171:3a7713b1edbc 104 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 105 * API
AnnaBridge 171:3a7713b1edbc 106 *******************************************************************************/
AnnaBridge 171:3a7713b1edbc 107
AnnaBridge 171:3a7713b1edbc 108 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 109 extern "C" {
AnnaBridge 171:3a7713b1edbc 110 #endif /* __cplusplus */
AnnaBridge 171:3a7713b1edbc 111
AnnaBridge 171:3a7713b1edbc 112 /*!
AnnaBridge 171:3a7713b1edbc 113 * @name EWM Initialization and De-initialization
AnnaBridge 171:3a7713b1edbc 114 * @{
AnnaBridge 171:3a7713b1edbc 115 */
AnnaBridge 171:3a7713b1edbc 116
AnnaBridge 171:3a7713b1edbc 117 /*!
AnnaBridge 171:3a7713b1edbc 118 * @brief Initializes the EWM peripheral.
AnnaBridge 171:3a7713b1edbc 119 *
AnnaBridge 171:3a7713b1edbc 120 * This function is used to initialize the EWM. After calling, the EWM
AnnaBridge 171:3a7713b1edbc 121 * runs immediately according to the configuration.
AnnaBridge 171:3a7713b1edbc 122 * Note that except for interrupt enable control bit, other control bits and registers are write once after a
AnnaBridge 171:3a7713b1edbc 123 * CPU reset. Modifying them more than once generates a bus transfer error.
AnnaBridge 171:3a7713b1edbc 124 *
AnnaBridge 171:3a7713b1edbc 125 * Example:
AnnaBridge 171:3a7713b1edbc 126 * @code
AnnaBridge 171:3a7713b1edbc 127 * ewm_config_t config;
AnnaBridge 171:3a7713b1edbc 128 * EWM_GetDefaultConfig(&config);
AnnaBridge 171:3a7713b1edbc 129 * config.compareHighValue = 0xAAU;
AnnaBridge 171:3a7713b1edbc 130 * EWM_Init(ewm_base,&config);
AnnaBridge 171:3a7713b1edbc 131 * @endcode
AnnaBridge 171:3a7713b1edbc 132 *
AnnaBridge 171:3a7713b1edbc 133 * @param base EWM peripheral base address
AnnaBridge 171:3a7713b1edbc 134 * @param config The configuration of EWM
AnnaBridge 171:3a7713b1edbc 135 */
AnnaBridge 171:3a7713b1edbc 136 void EWM_Init(EWM_Type *base, const ewm_config_t *config);
AnnaBridge 171:3a7713b1edbc 137
AnnaBridge 171:3a7713b1edbc 138 /*!
AnnaBridge 171:3a7713b1edbc 139 * @brief Deinitializes the EWM peripheral.
AnnaBridge 171:3a7713b1edbc 140 *
AnnaBridge 171:3a7713b1edbc 141 * This function is used to shut down the EWM.
AnnaBridge 171:3a7713b1edbc 142 *
AnnaBridge 171:3a7713b1edbc 143 * @param base EWM peripheral base address
AnnaBridge 171:3a7713b1edbc 144 */
AnnaBridge 171:3a7713b1edbc 145 void EWM_Deinit(EWM_Type *base);
AnnaBridge 171:3a7713b1edbc 146
AnnaBridge 171:3a7713b1edbc 147 /*!
AnnaBridge 171:3a7713b1edbc 148 * @brief Initializes the EWM configuration structure.
AnnaBridge 171:3a7713b1edbc 149 *
AnnaBridge 171:3a7713b1edbc 150 * This function initializes the EWM configure structure to default values. The default
AnnaBridge 171:3a7713b1edbc 151 * values are:
AnnaBridge 171:3a7713b1edbc 152 * @code
AnnaBridge 171:3a7713b1edbc 153 * ewmConfig->enableEwm = true;
AnnaBridge 171:3a7713b1edbc 154 * ewmConfig->enableEwmInput = false;
AnnaBridge 171:3a7713b1edbc 155 * ewmConfig->setInputAssertLogic = false;
AnnaBridge 171:3a7713b1edbc 156 * ewmConfig->enableInterrupt = false;
AnnaBridge 171:3a7713b1edbc 157 * ewmConfig->ewm_lpo_clock_source_t = kEWM_LpoClockSource0;
AnnaBridge 171:3a7713b1edbc 158 * ewmConfig->prescaler = 0;
AnnaBridge 171:3a7713b1edbc 159 * ewmConfig->compareLowValue = 0;
AnnaBridge 171:3a7713b1edbc 160 * ewmConfig->compareHighValue = 0xFEU;
AnnaBridge 171:3a7713b1edbc 161 * @endcode
AnnaBridge 171:3a7713b1edbc 162 *
AnnaBridge 171:3a7713b1edbc 163 * @param config Pointer to EWM configuration structure.
AnnaBridge 171:3a7713b1edbc 164 * @see ewm_config_t
AnnaBridge 171:3a7713b1edbc 165 */
AnnaBridge 171:3a7713b1edbc 166 void EWM_GetDefaultConfig(ewm_config_t *config);
AnnaBridge 171:3a7713b1edbc 167
AnnaBridge 171:3a7713b1edbc 168 /* @} */
AnnaBridge 171:3a7713b1edbc 169
AnnaBridge 171:3a7713b1edbc 170 /*!
AnnaBridge 171:3a7713b1edbc 171 * @name EWM functional Operation
AnnaBridge 171:3a7713b1edbc 172 * @{
AnnaBridge 171:3a7713b1edbc 173 */
AnnaBridge 171:3a7713b1edbc 174
AnnaBridge 171:3a7713b1edbc 175 /*!
AnnaBridge 171:3a7713b1edbc 176 * @brief Enables the EWM interrupt.
AnnaBridge 171:3a7713b1edbc 177 *
AnnaBridge 171:3a7713b1edbc 178 * This function enables the EWM interrupt.
AnnaBridge 171:3a7713b1edbc 179 *
AnnaBridge 171:3a7713b1edbc 180 * @param base EWM peripheral base address
AnnaBridge 171:3a7713b1edbc 181 * @param mask The interrupts to enable
AnnaBridge 171:3a7713b1edbc 182 * The parameter can be combination of the following source if defined:
AnnaBridge 171:3a7713b1edbc 183 * @arg kEWM_InterruptEnable
AnnaBridge 171:3a7713b1edbc 184 */
AnnaBridge 171:3a7713b1edbc 185 static inline void EWM_EnableInterrupts(EWM_Type *base, uint32_t mask)
AnnaBridge 171:3a7713b1edbc 186 {
AnnaBridge 171:3a7713b1edbc 187 base->CTRL |= mask;
AnnaBridge 171:3a7713b1edbc 188 }
AnnaBridge 171:3a7713b1edbc 189
AnnaBridge 171:3a7713b1edbc 190 /*!
AnnaBridge 171:3a7713b1edbc 191 * @brief Disables the EWM interrupt.
AnnaBridge 171:3a7713b1edbc 192 *
AnnaBridge 171:3a7713b1edbc 193 * This function enables the EWM interrupt.
AnnaBridge 171:3a7713b1edbc 194 *
AnnaBridge 171:3a7713b1edbc 195 * @param base EWM peripheral base address
AnnaBridge 171:3a7713b1edbc 196 * @param mask The interrupts to disable
AnnaBridge 171:3a7713b1edbc 197 * The parameter can be combination of the following source if defined:
AnnaBridge 171:3a7713b1edbc 198 * @arg kEWM_InterruptEnable
AnnaBridge 171:3a7713b1edbc 199 */
AnnaBridge 171:3a7713b1edbc 200 static inline void EWM_DisableInterrupts(EWM_Type *base, uint32_t mask)
AnnaBridge 171:3a7713b1edbc 201 {
AnnaBridge 171:3a7713b1edbc 202 base->CTRL &= ~mask;
AnnaBridge 171:3a7713b1edbc 203 }
AnnaBridge 171:3a7713b1edbc 204
AnnaBridge 171:3a7713b1edbc 205 /*!
AnnaBridge 171:3a7713b1edbc 206 * @brief Gets EWM all status flags.
AnnaBridge 171:3a7713b1edbc 207 *
AnnaBridge 171:3a7713b1edbc 208 * This function gets all status flags.
AnnaBridge 171:3a7713b1edbc 209 *
AnnaBridge 171:3a7713b1edbc 210 * Example for getting Running Flag:
AnnaBridge 171:3a7713b1edbc 211 * @code
AnnaBridge 171:3a7713b1edbc 212 * uint32_t status;
AnnaBridge 171:3a7713b1edbc 213 * status = EWM_GetStatusFlags(ewm_base) & kEWM_RunningFlag;
AnnaBridge 171:3a7713b1edbc 214 * @endcode
AnnaBridge 171:3a7713b1edbc 215 * @param base EWM peripheral base address
AnnaBridge 171:3a7713b1edbc 216 * @return State of the status flag: asserted (true) or not-asserted (false).@see _ewm_status_flags_t
AnnaBridge 171:3a7713b1edbc 217 * - true: related status flag has been set.
AnnaBridge 171:3a7713b1edbc 218 * - false: related status flag is not set.
AnnaBridge 171:3a7713b1edbc 219 */
AnnaBridge 171:3a7713b1edbc 220 static inline uint32_t EWM_GetStatusFlags(EWM_Type *base)
AnnaBridge 171:3a7713b1edbc 221 {
AnnaBridge 171:3a7713b1edbc 222 return (base->CTRL & EWM_CTRL_EWMEN_MASK);
AnnaBridge 171:3a7713b1edbc 223 }
AnnaBridge 171:3a7713b1edbc 224
AnnaBridge 171:3a7713b1edbc 225 /*!
AnnaBridge 171:3a7713b1edbc 226 * @brief Service EWM.
AnnaBridge 171:3a7713b1edbc 227 *
AnnaBridge 171:3a7713b1edbc 228 * This function reset EWM counter to zero.
AnnaBridge 171:3a7713b1edbc 229 *
AnnaBridge 171:3a7713b1edbc 230 * @param base EWM peripheral base address
AnnaBridge 171:3a7713b1edbc 231 */
AnnaBridge 171:3a7713b1edbc 232 void EWM_Refresh(EWM_Type *base);
AnnaBridge 171:3a7713b1edbc 233
AnnaBridge 171:3a7713b1edbc 234 /*@}*/
AnnaBridge 171:3a7713b1edbc 235
AnnaBridge 171:3a7713b1edbc 236 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 237 }
AnnaBridge 171:3a7713b1edbc 238 #endif /* __cplusplus */
AnnaBridge 171:3a7713b1edbc 239
AnnaBridge 171:3a7713b1edbc 240 /*! @}*/
AnnaBridge 171:3a7713b1edbc 241
AnnaBridge 171:3a7713b1edbc 242 #endif /* _FSL_EWM_H_ */