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_rtwdog.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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) 2016, 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 #ifndef _FSL_RTWDOG_H_
AnnaBridge 161:aa5281ff4a02 35 #define _FSL_RTWDOG_H_
AnnaBridge 161:aa5281ff4a02 36
AnnaBridge 161:aa5281ff4a02 37 #include "fsl_common.h"
AnnaBridge 161:aa5281ff4a02 38
AnnaBridge 161:aa5281ff4a02 39 /*!
AnnaBridge 161:aa5281ff4a02 40 * @addtogroup rtwdog
AnnaBridge 161:aa5281ff4a02 41 * @{
AnnaBridge 161:aa5281ff4a02 42 */
AnnaBridge 161:aa5281ff4a02 43
AnnaBridge 161:aa5281ff4a02 44
AnnaBridge 161:aa5281ff4a02 45 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 46 * Definitions
AnnaBridge 161:aa5281ff4a02 47 *******************************************************************************/
AnnaBridge 161:aa5281ff4a02 48 /*! @name Unlock sequence */
AnnaBridge 161:aa5281ff4a02 49 /*@{*/
AnnaBridge 161:aa5281ff4a02 50 #define WDOG_FIRST_WORD_OF_UNLOCK (RTWDOG_UPDATE_KEY & 0xFFFFU) /*!< First word of unlock sequence */
AnnaBridge 161:aa5281ff4a02 51 #define WDOG_SECOND_WORD_OF_UNLOCK ((RTWDOG_UPDATE_KEY >> 16U)& 0xFFFFU) /*!< Second word of unlock sequence */
AnnaBridge 161:aa5281ff4a02 52 /*@}*/
AnnaBridge 161:aa5281ff4a02 53
AnnaBridge 161:aa5281ff4a02 54 /*! @name Refresh sequence */
AnnaBridge 161:aa5281ff4a02 55 /*@{*/
AnnaBridge 161:aa5281ff4a02 56 #define WDOG_FIRST_WORD_OF_REFRESH (RTWDOG_REFRESH_KEY & 0xFFFFU) /*!< First word of refresh sequence */
AnnaBridge 161:aa5281ff4a02 57 #define WDOG_SECOND_WORD_OF_REFRESH ((RTWDOG_REFRESH_KEY >> 16U)& 0xFFFFU) /*!< Second word of refresh sequence */
AnnaBridge 161:aa5281ff4a02 58 /*@}*/
AnnaBridge 161:aa5281ff4a02 59 /*! @name Driver version */
AnnaBridge 161:aa5281ff4a02 60 /*@{*/
AnnaBridge 161:aa5281ff4a02 61 /*! @brief RTWDOG driver version 2.0.0. */
AnnaBridge 161:aa5281ff4a02 62 #define FSL_RTWDOG_DRIVER_VERSION (MAKE_VERSION(2, 0, 0))
AnnaBridge 161:aa5281ff4a02 63 /*@}*/
AnnaBridge 161:aa5281ff4a02 64
AnnaBridge 161:aa5281ff4a02 65 /*! @brief Describes RTWDOG clock source. */
AnnaBridge 161:aa5281ff4a02 66 typedef enum _rtwdog_clock_source
AnnaBridge 161:aa5281ff4a02 67 {
AnnaBridge 161:aa5281ff4a02 68 kRTWDOG_ClockSource0 = 0U, /*!< Clock source 0 */
AnnaBridge 161:aa5281ff4a02 69 kRTWDOG_ClockSource1 = 1U, /*!< Clock source 1 */
AnnaBridge 161:aa5281ff4a02 70 kRTWDOG_ClockSource2 = 2U, /*!< Clock source 2 */
AnnaBridge 161:aa5281ff4a02 71 kRTWDOG_ClockSource3 = 3U, /*!< Clock source 3 */
AnnaBridge 161:aa5281ff4a02 72 } rtwdog_clock_source_t;
AnnaBridge 161:aa5281ff4a02 73
AnnaBridge 161:aa5281ff4a02 74 /*! @brief Describes the selection of the clock prescaler. */
AnnaBridge 161:aa5281ff4a02 75 typedef enum _rtwdog_clock_prescaler
AnnaBridge 161:aa5281ff4a02 76 {
AnnaBridge 161:aa5281ff4a02 77 kRTWDOG_ClockPrescalerDivide1 = 0x0U, /*!< Divided by 1 */
AnnaBridge 161:aa5281ff4a02 78 kRTWDOG_ClockPrescalerDivide256 = 0x1U, /*!< Divided by 256 */
AnnaBridge 161:aa5281ff4a02 79 } rtwdog_clock_prescaler_t;
AnnaBridge 161:aa5281ff4a02 80
AnnaBridge 161:aa5281ff4a02 81 /*! @brief Defines RTWDOG work mode. */
AnnaBridge 161:aa5281ff4a02 82 typedef struct _rtwdog_work_mode
AnnaBridge 161:aa5281ff4a02 83 {
AnnaBridge 161:aa5281ff4a02 84 bool enableWait; /*!< Enables or disables RTWDOG in wait mode */
AnnaBridge 161:aa5281ff4a02 85 bool enableStop; /*!< Enables or disables RTWDOG in stop mode */
AnnaBridge 161:aa5281ff4a02 86 bool enableDebug; /*!< Enables or disables RTWDOG in debug mode */
AnnaBridge 161:aa5281ff4a02 87 } rtwdog_work_mode_t;
AnnaBridge 161:aa5281ff4a02 88
AnnaBridge 161:aa5281ff4a02 89 /*! @brief Describes RTWDOG test mode. */
AnnaBridge 161:aa5281ff4a02 90 typedef enum _rtwdog_test_mode
AnnaBridge 161:aa5281ff4a02 91 {
AnnaBridge 161:aa5281ff4a02 92 kRTWDOG_TestModeDisabled = 0U, /*!< Test Mode disabled */
AnnaBridge 161:aa5281ff4a02 93 kRTWDOG_UserModeEnabled = 1U, /*!< User Mode enabled */
AnnaBridge 161:aa5281ff4a02 94 kRTWDOG_LowByteTest = 2U, /*!< Test Mode enabled, only low byte is used */
AnnaBridge 161:aa5281ff4a02 95 kRTWDOG_HighByteTest = 3U, /*!< Test Mode enabled, only high byte is used */
AnnaBridge 161:aa5281ff4a02 96 } rtwdog_test_mode_t;
AnnaBridge 161:aa5281ff4a02 97
AnnaBridge 161:aa5281ff4a02 98 /*! @brief Describes RTWDOG configuration structure. */
AnnaBridge 161:aa5281ff4a02 99 typedef struct _rtwdog_config
AnnaBridge 161:aa5281ff4a02 100 {
AnnaBridge 161:aa5281ff4a02 101 bool enableRtwdog; /*!< Enables or disables RTWDOG */
AnnaBridge 161:aa5281ff4a02 102 rtwdog_clock_source_t clockSource; /*!< Clock source select */
AnnaBridge 161:aa5281ff4a02 103 rtwdog_clock_prescaler_t prescaler; /*!< Clock prescaler value */
AnnaBridge 161:aa5281ff4a02 104 rtwdog_work_mode_t workMode; /*!< Configures RTWDOG work mode in debug stop and wait mode */
AnnaBridge 161:aa5281ff4a02 105 rtwdog_test_mode_t testMode; /*!< Configures RTWDOG test mode */
AnnaBridge 161:aa5281ff4a02 106 bool enableUpdate; /*!< Update write-once register enable */
AnnaBridge 161:aa5281ff4a02 107 bool enableInterrupt; /*!< Enables or disables RTWDOG interrupt */
AnnaBridge 161:aa5281ff4a02 108 bool enableWindowMode; /*!< Enables or disables RTWDOG window mode */
AnnaBridge 161:aa5281ff4a02 109 uint16_t windowValue; /*!< Window value */
AnnaBridge 161:aa5281ff4a02 110 uint16_t timeoutValue; /*!< Timeout value */
AnnaBridge 161:aa5281ff4a02 111 } rtwdog_config_t;
AnnaBridge 161:aa5281ff4a02 112
AnnaBridge 161:aa5281ff4a02 113 /*!
AnnaBridge 161:aa5281ff4a02 114 * @brief RTWDOG interrupt configuration structure.
AnnaBridge 161:aa5281ff4a02 115 *
AnnaBridge 161:aa5281ff4a02 116 * This structure contains the settings for all of the RTWDOG interrupt configurations.
AnnaBridge 161:aa5281ff4a02 117 */
AnnaBridge 161:aa5281ff4a02 118 enum _rtwdog_interrupt_enable_t
AnnaBridge 161:aa5281ff4a02 119 {
AnnaBridge 161:aa5281ff4a02 120 kRTWDOG_InterruptEnable = RTWDOG_CS_INT_MASK, /*!< Interrupt is generated before forcing a reset */
AnnaBridge 161:aa5281ff4a02 121 };
AnnaBridge 161:aa5281ff4a02 122
AnnaBridge 161:aa5281ff4a02 123 /*!
AnnaBridge 161:aa5281ff4a02 124 * @brief RTWDOG status flags.
AnnaBridge 161:aa5281ff4a02 125 *
AnnaBridge 161:aa5281ff4a02 126 * This structure contains the RTWDOG status flags for use in the RTWDOG functions.
AnnaBridge 161:aa5281ff4a02 127 */
AnnaBridge 161:aa5281ff4a02 128 enum _rtwdog_status_flags_t
AnnaBridge 161:aa5281ff4a02 129 {
AnnaBridge 161:aa5281ff4a02 130 kRTWDOG_RunningFlag = RTWDOG_CS_EN_MASK, /*!< Running flag, set when RTWDOG is enabled */
AnnaBridge 161:aa5281ff4a02 131 kRTWDOG_InterruptFlag = RTWDOG_CS_FLG_MASK, /*!< Interrupt flag, set when interrupt occurs */
AnnaBridge 161:aa5281ff4a02 132 };
AnnaBridge 161:aa5281ff4a02 133
AnnaBridge 161:aa5281ff4a02 134 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 135 * API
AnnaBridge 161:aa5281ff4a02 136 *******************************************************************************/
AnnaBridge 161:aa5281ff4a02 137
AnnaBridge 161:aa5281ff4a02 138 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 139 extern "C" {
AnnaBridge 161:aa5281ff4a02 140 #endif /* __cplusplus */
AnnaBridge 161:aa5281ff4a02 141
AnnaBridge 161:aa5281ff4a02 142 /*!
AnnaBridge 161:aa5281ff4a02 143 * @name RTWDOG Initialization and De-initialization
AnnaBridge 161:aa5281ff4a02 144 * @{
AnnaBridge 161:aa5281ff4a02 145 */
AnnaBridge 161:aa5281ff4a02 146
AnnaBridge 161:aa5281ff4a02 147 /*!
AnnaBridge 161:aa5281ff4a02 148 * @brief Initializes the RTWDOG configuration structure.
AnnaBridge 161:aa5281ff4a02 149 *
AnnaBridge 161:aa5281ff4a02 150 * This function initializes the RTWDOG configuration structure to default values. The default
AnnaBridge 161:aa5281ff4a02 151 * values are:
AnnaBridge 161:aa5281ff4a02 152 * @code
AnnaBridge 161:aa5281ff4a02 153 * rtwdogConfig->enableRtwdog = true;
AnnaBridge 161:aa5281ff4a02 154 * rtwdogConfig->clockSource = kRTWDOG_ClockSource1;
AnnaBridge 161:aa5281ff4a02 155 * rtwdogConfig->prescaler = kRTWDOG_ClockPrescalerDivide1;
AnnaBridge 161:aa5281ff4a02 156 * rtwdogConfig->workMode.enableWait = true;
AnnaBridge 161:aa5281ff4a02 157 * rtwdogConfig->workMode.enableStop = false;
AnnaBridge 161:aa5281ff4a02 158 * rtwdogConfig->workMode.enableDebug = false;
AnnaBridge 161:aa5281ff4a02 159 * rtwdogConfig->testMode = kRTWDOG_TestModeDisabled;
AnnaBridge 161:aa5281ff4a02 160 * rtwdogConfig->enableUpdate = true;
AnnaBridge 161:aa5281ff4a02 161 * rtwdogConfig->enableInterrupt = false;
AnnaBridge 161:aa5281ff4a02 162 * rtwdogConfig->enableWindowMode = false;
AnnaBridge 161:aa5281ff4a02 163 * rtwdogConfig->windowValue = 0U;
AnnaBridge 161:aa5281ff4a02 164 * rtwdogConfig->timeoutValue = 0xFFFFU;
AnnaBridge 161:aa5281ff4a02 165 * @endcode
AnnaBridge 161:aa5281ff4a02 166 *
AnnaBridge 161:aa5281ff4a02 167 * @param config Pointer to the RTWDOG configuration structure.
AnnaBridge 161:aa5281ff4a02 168 * @see rtwdog_config_t
AnnaBridge 161:aa5281ff4a02 169 */
AnnaBridge 161:aa5281ff4a02 170 void RTWDOG_GetDefaultConfig(rtwdog_config_t *config);
AnnaBridge 161:aa5281ff4a02 171
AnnaBridge 161:aa5281ff4a02 172 /*!
AnnaBridge 161:aa5281ff4a02 173 * @brief Initializes the RTWDOG module.
AnnaBridge 161:aa5281ff4a02 174 *
AnnaBridge 161:aa5281ff4a02 175 * This function initializes the RTWDOG.
AnnaBridge 161:aa5281ff4a02 176 * To reconfigure the RTWDOG without forcing a reset first, enableUpdate must be set to true
AnnaBridge 161:aa5281ff4a02 177 * in the configuration.
AnnaBridge 161:aa5281ff4a02 178 *
AnnaBridge 161:aa5281ff4a02 179 * Example:
AnnaBridge 161:aa5281ff4a02 180 * @code
AnnaBridge 161:aa5281ff4a02 181 * rtwdog_config_t config;
AnnaBridge 161:aa5281ff4a02 182 * RTWDOG_GetDefaultConfig(&config);
AnnaBridge 161:aa5281ff4a02 183 * config.timeoutValue = 0x7ffU;
AnnaBridge 161:aa5281ff4a02 184 * config.enableUpdate = true;
AnnaBridge 161:aa5281ff4a02 185 * RTWDOG_Init(wdog_base,&config);
AnnaBridge 161:aa5281ff4a02 186 * @endcode
AnnaBridge 161:aa5281ff4a02 187 *
AnnaBridge 161:aa5281ff4a02 188 * @param base RTWDOG peripheral base address.
AnnaBridge 161:aa5281ff4a02 189 * @param config The configuration of the RTWDOG.
AnnaBridge 161:aa5281ff4a02 190 */
AnnaBridge 161:aa5281ff4a02 191 void RTWDOG_Init(RTWDOG_Type *base, const rtwdog_config_t *config);
AnnaBridge 161:aa5281ff4a02 192
AnnaBridge 161:aa5281ff4a02 193 /*!
AnnaBridge 161:aa5281ff4a02 194 * @brief De-initializes the RTWDOG module.
AnnaBridge 161:aa5281ff4a02 195 *
AnnaBridge 161:aa5281ff4a02 196 * This function shuts down the RTWDOG.
AnnaBridge 161:aa5281ff4a02 197 * Ensure that the WDOG_CS.UPDATE is 1, which means that the register update is enabled.
AnnaBridge 161:aa5281ff4a02 198 *
AnnaBridge 161:aa5281ff4a02 199 * @param base RTWDOG peripheral base address.
AnnaBridge 161:aa5281ff4a02 200 */
AnnaBridge 161:aa5281ff4a02 201 void RTWDOG_Deinit(RTWDOG_Type *base);
AnnaBridge 161:aa5281ff4a02 202
AnnaBridge 161:aa5281ff4a02 203 /* @} */
AnnaBridge 161:aa5281ff4a02 204
AnnaBridge 161:aa5281ff4a02 205 /*!
AnnaBridge 161:aa5281ff4a02 206 * @name RTWDOG functional Operation
AnnaBridge 161:aa5281ff4a02 207 * @{
AnnaBridge 161:aa5281ff4a02 208 */
AnnaBridge 161:aa5281ff4a02 209
AnnaBridge 161:aa5281ff4a02 210 /*!
AnnaBridge 161:aa5281ff4a02 211 * @brief Enables the RTWDOG module.
AnnaBridge 161:aa5281ff4a02 212 *
AnnaBridge 161:aa5281ff4a02 213 * This function writes a value into the WDOG_CS register to enable the RTWDOG.
AnnaBridge 161:aa5281ff4a02 214 * The WDOG_CS register is a write-once register. Ensure that the WCT window is still open and
AnnaBridge 161:aa5281ff4a02 215 * this register has not been written in this WCT while the function is called.
AnnaBridge 161:aa5281ff4a02 216 *
AnnaBridge 161:aa5281ff4a02 217 * @param base RTWDOG peripheral base address.
AnnaBridge 161:aa5281ff4a02 218 */
AnnaBridge 161:aa5281ff4a02 219 static inline void RTWDOG_Enable(RTWDOG_Type *base)
AnnaBridge 161:aa5281ff4a02 220 {
AnnaBridge 161:aa5281ff4a02 221 base->CS |= RTWDOG_CS_EN_MASK;
AnnaBridge 161:aa5281ff4a02 222 }
AnnaBridge 161:aa5281ff4a02 223
AnnaBridge 161:aa5281ff4a02 224 /*!
AnnaBridge 161:aa5281ff4a02 225 * @brief Disables the RTWDOG module.
AnnaBridge 161:aa5281ff4a02 226 *
AnnaBridge 161:aa5281ff4a02 227 * This function writes a value into the WDOG_CS register to disable the RTWDOG.
AnnaBridge 161:aa5281ff4a02 228 * The WDOG_CS register is a write-once register. Ensure that the WCT window is still open and
AnnaBridge 161:aa5281ff4a02 229 * this register has not been written in this WCT while the function is called.
AnnaBridge 161:aa5281ff4a02 230 *
AnnaBridge 161:aa5281ff4a02 231 * @param base RTWDOG peripheral base address
AnnaBridge 161:aa5281ff4a02 232 */
AnnaBridge 161:aa5281ff4a02 233 static inline void RTWDOG_Disable(RTWDOG_Type *base)
AnnaBridge 161:aa5281ff4a02 234 {
AnnaBridge 161:aa5281ff4a02 235 base->CS &= ~RTWDOG_CS_EN_MASK;
AnnaBridge 161:aa5281ff4a02 236 }
AnnaBridge 161:aa5281ff4a02 237
AnnaBridge 161:aa5281ff4a02 238 /*!
AnnaBridge 161:aa5281ff4a02 239 * @brief Enables the RTWDOG interrupt.
AnnaBridge 161:aa5281ff4a02 240 *
AnnaBridge 161:aa5281ff4a02 241 * This function writes a value into the WDOG_CS register to enable the RTWDOG interrupt.
AnnaBridge 161:aa5281ff4a02 242 * The WDOG_CS register is a write-once register. Ensure that the WCT window is still open and
AnnaBridge 161:aa5281ff4a02 243 * this register has not been written in this WCT while the function is called.
AnnaBridge 161:aa5281ff4a02 244 *
AnnaBridge 161:aa5281ff4a02 245 * @param base RTWDOG peripheral base address.
AnnaBridge 161:aa5281ff4a02 246 * @param mask The interrupts to enable.
AnnaBridge 161:aa5281ff4a02 247 * The parameter can be a combination of the following source if defined:
AnnaBridge 161:aa5281ff4a02 248 * @arg kRTWDOG_InterruptEnable
AnnaBridge 161:aa5281ff4a02 249 */
AnnaBridge 161:aa5281ff4a02 250 static inline void RTWDOG_EnableInterrupts(RTWDOG_Type *base, uint32_t mask)
AnnaBridge 161:aa5281ff4a02 251 {
AnnaBridge 161:aa5281ff4a02 252 base->CS |= mask;
AnnaBridge 161:aa5281ff4a02 253 }
AnnaBridge 161:aa5281ff4a02 254
AnnaBridge 161:aa5281ff4a02 255 /*!
AnnaBridge 161:aa5281ff4a02 256 * @brief Disables the RTWDOG interrupt.
AnnaBridge 161:aa5281ff4a02 257 *
AnnaBridge 161:aa5281ff4a02 258 * This function writes a value into the WDOG_CS register to disable the RTWDOG interrupt.
AnnaBridge 161:aa5281ff4a02 259 * The WDOG_CS register is a write-once register. Ensure that the WCT window is still open and
AnnaBridge 161:aa5281ff4a02 260 * this register has not been written in this WCT while the function is called.
AnnaBridge 161:aa5281ff4a02 261 *
AnnaBridge 161:aa5281ff4a02 262 * @param base RTWDOG peripheral base address.
AnnaBridge 161:aa5281ff4a02 263 * @param mask The interrupts to disabled.
AnnaBridge 161:aa5281ff4a02 264 * The parameter can be a combination of the following source if defined:
AnnaBridge 161:aa5281ff4a02 265 * @arg kRTWDOG_InterruptEnable
AnnaBridge 161:aa5281ff4a02 266 */
AnnaBridge 161:aa5281ff4a02 267 static inline void RTWDOG_DisableInterrupts(RTWDOG_Type *base, uint32_t mask)
AnnaBridge 161:aa5281ff4a02 268 {
AnnaBridge 161:aa5281ff4a02 269 base->CS &= ~mask;
AnnaBridge 161:aa5281ff4a02 270 }
AnnaBridge 161:aa5281ff4a02 271
AnnaBridge 161:aa5281ff4a02 272 /*!
AnnaBridge 161:aa5281ff4a02 273 * @brief Gets the RTWDOG all status flags.
AnnaBridge 161:aa5281ff4a02 274 *
AnnaBridge 161:aa5281ff4a02 275 * This function gets all status flags.
AnnaBridge 161:aa5281ff4a02 276 *
AnnaBridge 161:aa5281ff4a02 277 * Example to get the running flag:
AnnaBridge 161:aa5281ff4a02 278 * @code
AnnaBridge 161:aa5281ff4a02 279 * uint32_t status;
AnnaBridge 161:aa5281ff4a02 280 * status = RTWDOG_GetStatusFlags(wdog_base) & kRTWDOG_RunningFlag;
AnnaBridge 161:aa5281ff4a02 281 * @endcode
AnnaBridge 161:aa5281ff4a02 282 * @param base RTWDOG peripheral base address
AnnaBridge 161:aa5281ff4a02 283 * @return State of the status flag: asserted (true) or not-asserted (false). @see _rtwdog_status_flags_t
AnnaBridge 161:aa5281ff4a02 284 * - true: related status flag has been set.
AnnaBridge 161:aa5281ff4a02 285 * - false: related status flag is not set.
AnnaBridge 161:aa5281ff4a02 286 */
AnnaBridge 161:aa5281ff4a02 287 static inline uint32_t RTWDOG_GetStatusFlags(RTWDOG_Type *base)
AnnaBridge 161:aa5281ff4a02 288 {
AnnaBridge 161:aa5281ff4a02 289 return (base->CS & (RTWDOG_CS_EN_MASK | RTWDOG_CS_FLG_MASK));
AnnaBridge 161:aa5281ff4a02 290 }
AnnaBridge 161:aa5281ff4a02 291
AnnaBridge 161:aa5281ff4a02 292 /*!
AnnaBridge 161:aa5281ff4a02 293 * @brief Clears the RTWDOG flag.
AnnaBridge 161:aa5281ff4a02 294 *
AnnaBridge 161:aa5281ff4a02 295 * This function clears the RTWDOG status flag.
AnnaBridge 161:aa5281ff4a02 296 *
AnnaBridge 161:aa5281ff4a02 297 * Example to clear an interrupt flag:
AnnaBridge 161:aa5281ff4a02 298 * @code
AnnaBridge 161:aa5281ff4a02 299 * RTWDOG_ClearStatusFlags(wdog_base,kRTWDOG_InterruptFlag);
AnnaBridge 161:aa5281ff4a02 300 * @endcode
AnnaBridge 161:aa5281ff4a02 301 * @param base RTWDOG peripheral base address.
AnnaBridge 161:aa5281ff4a02 302 * @param mask The status flags to clear.
AnnaBridge 161:aa5281ff4a02 303 * The parameter can be any combination of the following values:
AnnaBridge 161:aa5281ff4a02 304 * @arg kRTWDOG_InterruptFlag
AnnaBridge 161:aa5281ff4a02 305 */
AnnaBridge 161:aa5281ff4a02 306 void RTWDOG_ClearStatusFlags(RTWDOG_Type *base, uint32_t mask);
AnnaBridge 161:aa5281ff4a02 307
AnnaBridge 161:aa5281ff4a02 308 /*!
AnnaBridge 161:aa5281ff4a02 309 * @brief Sets the RTWDOG timeout value.
AnnaBridge 161:aa5281ff4a02 310 *
AnnaBridge 161:aa5281ff4a02 311 * This function writes a timeout value into the WDOG_TOVAL register.
AnnaBridge 161:aa5281ff4a02 312 * The WDOG_TOVAL register is a write-once register. Ensure that the WCT window is still open and
AnnaBridge 161:aa5281ff4a02 313 * this register has not been written in this WCT while the function is called.
AnnaBridge 161:aa5281ff4a02 314 *
AnnaBridge 161:aa5281ff4a02 315 * @param base RTWDOG peripheral base address
AnnaBridge 161:aa5281ff4a02 316 * @param timeoutCount RTWDOG timeout value, count of RTWDOG clock ticks.
AnnaBridge 161:aa5281ff4a02 317 */
AnnaBridge 161:aa5281ff4a02 318 static inline void RTWDOG_SetTimeoutValue(RTWDOG_Type *base, uint16_t timeoutCount)
AnnaBridge 161:aa5281ff4a02 319 {
AnnaBridge 161:aa5281ff4a02 320 base->TOVAL = timeoutCount;
AnnaBridge 161:aa5281ff4a02 321 }
AnnaBridge 161:aa5281ff4a02 322
AnnaBridge 161:aa5281ff4a02 323 /*!
AnnaBridge 161:aa5281ff4a02 324 * @brief Sets the RTWDOG window value.
AnnaBridge 161:aa5281ff4a02 325 *
AnnaBridge 161:aa5281ff4a02 326 * This function writes a window value into the WDOG_WIN register.
AnnaBridge 161:aa5281ff4a02 327 * The WDOG_WIN register is a write-once register. Ensure that the WCT window is still open and
AnnaBridge 161:aa5281ff4a02 328 * this register has not been written in this WCT while the function is called.
AnnaBridge 161:aa5281ff4a02 329 *
AnnaBridge 161:aa5281ff4a02 330 * @param base RTWDOG peripheral base address.
AnnaBridge 161:aa5281ff4a02 331 * @param windowValue RTWDOG window value.
AnnaBridge 161:aa5281ff4a02 332 */
AnnaBridge 161:aa5281ff4a02 333 static inline void RTWDOG_SetWindowValue(RTWDOG_Type *base, uint16_t windowValue)
AnnaBridge 161:aa5281ff4a02 334 {
AnnaBridge 161:aa5281ff4a02 335 base->WIN = windowValue;
AnnaBridge 161:aa5281ff4a02 336 }
AnnaBridge 161:aa5281ff4a02 337
AnnaBridge 161:aa5281ff4a02 338 /*!
AnnaBridge 161:aa5281ff4a02 339 * @brief Unlocks the RTWDOG register written.
AnnaBridge 161:aa5281ff4a02 340 *
AnnaBridge 161:aa5281ff4a02 341 * This function unlocks the RTWDOG register written.
AnnaBridge 161:aa5281ff4a02 342 *
AnnaBridge 161:aa5281ff4a02 343 * Before starting the unlock sequence and following the configuration, disable the global interrupts.
AnnaBridge 161:aa5281ff4a02 344 * Otherwise, an interrupt could effectively invalidate the unlock sequence and the WCT may expire.
AnnaBridge 161:aa5281ff4a02 345 * After the configuration finishes, re-enable the global interrupts.
AnnaBridge 161:aa5281ff4a02 346 *
AnnaBridge 161:aa5281ff4a02 347 * @param base RTWDOG peripheral base address
AnnaBridge 161:aa5281ff4a02 348 */
AnnaBridge 161:aa5281ff4a02 349 static inline void RTWDOG_Unlock(RTWDOG_Type *base)
AnnaBridge 161:aa5281ff4a02 350 {
AnnaBridge 161:aa5281ff4a02 351 if ((base->CS) & RTWDOG_CS_CMD32EN_MASK)
AnnaBridge 161:aa5281ff4a02 352 {
AnnaBridge 161:aa5281ff4a02 353 base->CNT = RTWDOG_UPDATE_KEY;
AnnaBridge 161:aa5281ff4a02 354 }
AnnaBridge 161:aa5281ff4a02 355 else
AnnaBridge 161:aa5281ff4a02 356 {
AnnaBridge 161:aa5281ff4a02 357 base->CNT = WDOG_FIRST_WORD_OF_UNLOCK;
AnnaBridge 161:aa5281ff4a02 358 base->CNT = WDOG_SECOND_WORD_OF_UNLOCK;
AnnaBridge 161:aa5281ff4a02 359 }
AnnaBridge 161:aa5281ff4a02 360 }
AnnaBridge 161:aa5281ff4a02 361
AnnaBridge 161:aa5281ff4a02 362 /*!
AnnaBridge 161:aa5281ff4a02 363 * @brief Refreshes the RTWDOG timer.
AnnaBridge 161:aa5281ff4a02 364 *
AnnaBridge 161:aa5281ff4a02 365 * This function feeds the RTWDOG.
AnnaBridge 161:aa5281ff4a02 366 * This function should be called before the Watchdog timer is in timeout. Otherwise, a reset is asserted.
AnnaBridge 161:aa5281ff4a02 367 *
AnnaBridge 161:aa5281ff4a02 368 * @param base RTWDOG peripheral base address
AnnaBridge 161:aa5281ff4a02 369 */
AnnaBridge 161:aa5281ff4a02 370 static inline void RTWDOG_Refresh(RTWDOG_Type *base)
AnnaBridge 161:aa5281ff4a02 371 {
AnnaBridge 161:aa5281ff4a02 372 if ((base->CS) & RTWDOG_CS_CMD32EN_MASK)
AnnaBridge 161:aa5281ff4a02 373 {
AnnaBridge 161:aa5281ff4a02 374 base->CNT = RTWDOG_REFRESH_KEY;
AnnaBridge 161:aa5281ff4a02 375 }
AnnaBridge 161:aa5281ff4a02 376 else
AnnaBridge 161:aa5281ff4a02 377 {
AnnaBridge 161:aa5281ff4a02 378 base->CNT = WDOG_FIRST_WORD_OF_REFRESH;
AnnaBridge 161:aa5281ff4a02 379 base->CNT = WDOG_SECOND_WORD_OF_REFRESH;
AnnaBridge 161:aa5281ff4a02 380 }
AnnaBridge 161:aa5281ff4a02 381 }
AnnaBridge 161:aa5281ff4a02 382
AnnaBridge 161:aa5281ff4a02 383 /*!
AnnaBridge 161:aa5281ff4a02 384 * @brief Gets the RTWDOG counter value.
AnnaBridge 161:aa5281ff4a02 385 *
AnnaBridge 161:aa5281ff4a02 386 * This function gets the RTWDOG counter value.
AnnaBridge 161:aa5281ff4a02 387 *
AnnaBridge 161:aa5281ff4a02 388 * @param base RTWDOG peripheral base address.
AnnaBridge 161:aa5281ff4a02 389 * @return Current RTWDOG counter value.
AnnaBridge 161:aa5281ff4a02 390 */
AnnaBridge 161:aa5281ff4a02 391 static inline uint16_t RTWDOG_GetCounterValue(RTWDOG_Type *base)
AnnaBridge 161:aa5281ff4a02 392 {
AnnaBridge 161:aa5281ff4a02 393 return base->CNT;
AnnaBridge 161:aa5281ff4a02 394 }
AnnaBridge 161:aa5281ff4a02 395
AnnaBridge 161:aa5281ff4a02 396 /*@}*/
AnnaBridge 161:aa5281ff4a02 397
AnnaBridge 161:aa5281ff4a02 398 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 399 }
AnnaBridge 161:aa5281ff4a02 400 #endif /* __cplusplus */
AnnaBridge 161:aa5281ff4a02 401
AnnaBridge 161:aa5281ff4a02 402 /*! @}*/
AnnaBridge 161:aa5281ff4a02 403
AnnaBridge 161:aa5281ff4a02 404 #endif /* _FSL_RTWDOG_H_ */