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_wdog.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 #ifndef _FSL_WDOG_H_
AnnaBridge 189:f392fc9709a3 31 #define _FSL_WDOG_H_
AnnaBridge 189:f392fc9709a3 32
AnnaBridge 189:f392fc9709a3 33 #include "fsl_common.h"
AnnaBridge 189:f392fc9709a3 34
AnnaBridge 189:f392fc9709a3 35 /*!
AnnaBridge 189:f392fc9709a3 36 * @addtogroup wdog
AnnaBridge 189:f392fc9709a3 37 * @{
AnnaBridge 189:f392fc9709a3 38 */
AnnaBridge 189:f392fc9709a3 39
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 42 * Definitions
AnnaBridge 189:f392fc9709a3 43 *******************************************************************************/
AnnaBridge 189:f392fc9709a3 44
AnnaBridge 189:f392fc9709a3 45 /*! @name Driver version */
AnnaBridge 189:f392fc9709a3 46 /*@{*/
AnnaBridge 189:f392fc9709a3 47 /*! @brief Defines WDOG driver version 2.0.0. */
AnnaBridge 189:f392fc9709a3 48 #define FSL_WDOG_DRIVER_VERSION (MAKE_VERSION(2, 0, 0))
AnnaBridge 189:f392fc9709a3 49 /*@}*/
AnnaBridge 189:f392fc9709a3 50
AnnaBridge 189:f392fc9709a3 51 /*! @name Unlock sequence */
AnnaBridge 189:f392fc9709a3 52 /*@{*/
AnnaBridge 189:f392fc9709a3 53 #define WDOG_FIRST_WORD_OF_UNLOCK (0xC520U) /*!< First word of unlock sequence */
AnnaBridge 189:f392fc9709a3 54 #define WDOG_SECOND_WORD_OF_UNLOCK (0xD928U) /*!< Second word of unlock sequence */
AnnaBridge 189:f392fc9709a3 55 /*@}*/
AnnaBridge 189:f392fc9709a3 56
AnnaBridge 189:f392fc9709a3 57 /*! @name Refresh sequence */
AnnaBridge 189:f392fc9709a3 58 /*@{*/
AnnaBridge 189:f392fc9709a3 59 #define WDOG_FIRST_WORD_OF_REFRESH (0xA602U) /*!< First word of refresh sequence */
AnnaBridge 189:f392fc9709a3 60 #define WDOG_SECOND_WORD_OF_REFRESH (0xB480U) /*!< Second word of refresh sequence */
AnnaBridge 189:f392fc9709a3 61 /*@}*/
AnnaBridge 189:f392fc9709a3 62
AnnaBridge 189:f392fc9709a3 63 /*! @brief Describes WDOG clock source. */
AnnaBridge 189:f392fc9709a3 64 typedef enum _wdog_clock_source
AnnaBridge 189:f392fc9709a3 65 {
AnnaBridge 189:f392fc9709a3 66 kWDOG_LpoClockSource = 0U, /*!< WDOG clock sourced from LPO*/
AnnaBridge 189:f392fc9709a3 67 kWDOG_AlternateClockSource = 1U, /*!< WDOG clock sourced from alternate clock source*/
AnnaBridge 189:f392fc9709a3 68 } wdog_clock_source_t;
AnnaBridge 189:f392fc9709a3 69
AnnaBridge 189:f392fc9709a3 70 /*! @brief Defines WDOG work mode. */
AnnaBridge 189:f392fc9709a3 71 typedef struct _wdog_work_mode
AnnaBridge 189:f392fc9709a3 72 {
AnnaBridge 189:f392fc9709a3 73 #if defined(FSL_FEATURE_WDOG_HAS_WAITEN) && FSL_FEATURE_WDOG_HAS_WAITEN
AnnaBridge 189:f392fc9709a3 74 bool enableWait; /*!< Enables or disables WDOG in wait mode */
AnnaBridge 189:f392fc9709a3 75 #endif /* FSL_FEATURE_WDOG_HAS_WAITEN */
AnnaBridge 189:f392fc9709a3 76 bool enableStop; /*!< Enables or disables WDOG in stop mode */
AnnaBridge 189:f392fc9709a3 77 bool enableDebug; /*!< Enables or disables WDOG in debug mode */
AnnaBridge 189:f392fc9709a3 78 } wdog_work_mode_t;
AnnaBridge 189:f392fc9709a3 79
AnnaBridge 189:f392fc9709a3 80 /*! @brief Describes the selection of the clock prescaler. */
AnnaBridge 189:f392fc9709a3 81 typedef enum _wdog_clock_prescaler
AnnaBridge 189:f392fc9709a3 82 {
AnnaBridge 189:f392fc9709a3 83 kWDOG_ClockPrescalerDivide1 = 0x0U, /*!< Divided by 1 */
AnnaBridge 189:f392fc9709a3 84 kWDOG_ClockPrescalerDivide2 = 0x1U, /*!< Divided by 2 */
AnnaBridge 189:f392fc9709a3 85 kWDOG_ClockPrescalerDivide3 = 0x2U, /*!< Divided by 3 */
AnnaBridge 189:f392fc9709a3 86 kWDOG_ClockPrescalerDivide4 = 0x3U, /*!< Divided by 4 */
AnnaBridge 189:f392fc9709a3 87 kWDOG_ClockPrescalerDivide5 = 0x4U, /*!< Divided by 5 */
AnnaBridge 189:f392fc9709a3 88 kWDOG_ClockPrescalerDivide6 = 0x5U, /*!< Divided by 6 */
AnnaBridge 189:f392fc9709a3 89 kWDOG_ClockPrescalerDivide7 = 0x6U, /*!< Divided by 7 */
AnnaBridge 189:f392fc9709a3 90 kWDOG_ClockPrescalerDivide8 = 0x7U, /*!< Divided by 8 */
AnnaBridge 189:f392fc9709a3 91 } wdog_clock_prescaler_t;
AnnaBridge 189:f392fc9709a3 92
AnnaBridge 189:f392fc9709a3 93 /*! @brief Describes WDOG configuration structure. */
AnnaBridge 189:f392fc9709a3 94 typedef struct _wdog_config
AnnaBridge 189:f392fc9709a3 95 {
AnnaBridge 189:f392fc9709a3 96 bool enableWdog; /*!< Enables or disables WDOG */
AnnaBridge 189:f392fc9709a3 97 wdog_clock_source_t clockSource; /*!< Clock source select */
AnnaBridge 189:f392fc9709a3 98 wdog_clock_prescaler_t prescaler; /*!< Clock prescaler value */
AnnaBridge 189:f392fc9709a3 99 wdog_work_mode_t workMode; /*!< Configures WDOG work mode in debug stop and wait mode */
AnnaBridge 189:f392fc9709a3 100 bool enableUpdate; /*!< Update write-once register enable */
AnnaBridge 189:f392fc9709a3 101 bool enableInterrupt; /*!< Enables or disables WDOG interrupt */
AnnaBridge 189:f392fc9709a3 102 bool enableWindowMode; /*!< Enables or disables WDOG window mode */
AnnaBridge 189:f392fc9709a3 103 uint32_t windowValue; /*!< Window value */
AnnaBridge 189:f392fc9709a3 104 uint32_t timeoutValue; /*!< Timeout value */
AnnaBridge 189:f392fc9709a3 105 } wdog_config_t;
AnnaBridge 189:f392fc9709a3 106
AnnaBridge 189:f392fc9709a3 107 /*! @brief Describes WDOG test mode. */
AnnaBridge 189:f392fc9709a3 108 typedef enum _wdog_test_mode
AnnaBridge 189:f392fc9709a3 109 {
AnnaBridge 189:f392fc9709a3 110 kWDOG_QuickTest = 0U, /*!< Selects quick test */
AnnaBridge 189:f392fc9709a3 111 kWDOG_ByteTest = 1U, /*!< Selects byte test */
AnnaBridge 189:f392fc9709a3 112 } wdog_test_mode_t;
AnnaBridge 189:f392fc9709a3 113
AnnaBridge 189:f392fc9709a3 114 /*! @brief Describes WDOG tested byte selection in byte test mode. */
AnnaBridge 189:f392fc9709a3 115 typedef enum _wdog_tested_byte
AnnaBridge 189:f392fc9709a3 116 {
AnnaBridge 189:f392fc9709a3 117 kWDOG_TestByte0 = 0U, /*!< Byte 0 selected in byte test mode */
AnnaBridge 189:f392fc9709a3 118 kWDOG_TestByte1 = 1U, /*!< Byte 1 selected in byte test mode */
AnnaBridge 189:f392fc9709a3 119 kWDOG_TestByte2 = 2U, /*!< Byte 2 selected in byte test mode */
AnnaBridge 189:f392fc9709a3 120 kWDOG_TestByte3 = 3U, /*!< Byte 3 selected in byte test mode */
AnnaBridge 189:f392fc9709a3 121 } wdog_tested_byte_t;
AnnaBridge 189:f392fc9709a3 122
AnnaBridge 189:f392fc9709a3 123 /*! @brief Describes WDOG test mode configuration structure. */
AnnaBridge 189:f392fc9709a3 124 typedef struct _wdog_test_config
AnnaBridge 189:f392fc9709a3 125 {
AnnaBridge 189:f392fc9709a3 126 wdog_test_mode_t testMode; /*!< Selects test mode */
AnnaBridge 189:f392fc9709a3 127 wdog_tested_byte_t testedByte; /*!< Selects tested byte in byte test mode */
AnnaBridge 189:f392fc9709a3 128 uint32_t timeoutValue; /*!< Timeout value */
AnnaBridge 189:f392fc9709a3 129 } wdog_test_config_t;
AnnaBridge 189:f392fc9709a3 130
AnnaBridge 189:f392fc9709a3 131 /*!
AnnaBridge 189:f392fc9709a3 132 * @brief WDOG interrupt configuration structure, default settings all disabled.
AnnaBridge 189:f392fc9709a3 133 *
AnnaBridge 189:f392fc9709a3 134 * This structure contains the settings for all of the WDOG interrupt configurations.
AnnaBridge 189:f392fc9709a3 135 */
AnnaBridge 189:f392fc9709a3 136 enum _wdog_interrupt_enable_t
AnnaBridge 189:f392fc9709a3 137 {
AnnaBridge 189:f392fc9709a3 138 kWDOG_InterruptEnable = WDOG_STCTRLH_IRQRSTEN_MASK, /*!< WDOG timeout generates an interrupt before reset*/
AnnaBridge 189:f392fc9709a3 139 };
AnnaBridge 189:f392fc9709a3 140
AnnaBridge 189:f392fc9709a3 141 /*!
AnnaBridge 189:f392fc9709a3 142 * @brief WDOG status flags.
AnnaBridge 189:f392fc9709a3 143 *
AnnaBridge 189:f392fc9709a3 144 * This structure contains the WDOG status flags for use in the WDOG functions.
AnnaBridge 189:f392fc9709a3 145 */
AnnaBridge 189:f392fc9709a3 146 enum _wdog_status_flags_t
AnnaBridge 189:f392fc9709a3 147 {
AnnaBridge 189:f392fc9709a3 148 kWDOG_RunningFlag = WDOG_STCTRLH_WDOGEN_MASK, /*!< Running flag, set when WDOG is enabled*/
AnnaBridge 189:f392fc9709a3 149 kWDOG_TimeoutFlag = WDOG_STCTRLL_INTFLG_MASK, /*!< Interrupt flag, set when an exception occurs*/
AnnaBridge 189:f392fc9709a3 150 };
AnnaBridge 189:f392fc9709a3 151
AnnaBridge 189:f392fc9709a3 152 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 153 * API
AnnaBridge 189:f392fc9709a3 154 *******************************************************************************/
AnnaBridge 189:f392fc9709a3 155
AnnaBridge 189:f392fc9709a3 156 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 157 extern "C" {
AnnaBridge 189:f392fc9709a3 158 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 159
AnnaBridge 189:f392fc9709a3 160 /*!
AnnaBridge 189:f392fc9709a3 161 * @name WDOG Initialization and De-initialization
AnnaBridge 189:f392fc9709a3 162 * @{
AnnaBridge 189:f392fc9709a3 163 */
AnnaBridge 189:f392fc9709a3 164
AnnaBridge 189:f392fc9709a3 165 /*!
AnnaBridge 189:f392fc9709a3 166 * @brief Initializes the WDOG configuration sturcture.
AnnaBridge 189:f392fc9709a3 167 *
AnnaBridge 189:f392fc9709a3 168 * This function initializes the WDOG configuration structure to default values. The default
AnnaBridge 189:f392fc9709a3 169 * values are as follows.
AnnaBridge 189:f392fc9709a3 170 * @code
AnnaBridge 189:f392fc9709a3 171 * wdogConfig->enableWdog = true;
AnnaBridge 189:f392fc9709a3 172 * wdogConfig->clockSource = kWDOG_LpoClockSource;
AnnaBridge 189:f392fc9709a3 173 * wdogConfig->prescaler = kWDOG_ClockPrescalerDivide1;
AnnaBridge 189:f392fc9709a3 174 * wdogConfig->workMode.enableWait = true;
AnnaBridge 189:f392fc9709a3 175 * wdogConfig->workMode.enableStop = false;
AnnaBridge 189:f392fc9709a3 176 * wdogConfig->workMode.enableDebug = false;
AnnaBridge 189:f392fc9709a3 177 * wdogConfig->enableUpdate = true;
AnnaBridge 189:f392fc9709a3 178 * wdogConfig->enableInterrupt = false;
AnnaBridge 189:f392fc9709a3 179 * wdogConfig->enableWindowMode = false;
AnnaBridge 189:f392fc9709a3 180 * wdogConfig->windowValue = 0;
AnnaBridge 189:f392fc9709a3 181 * wdogConfig->timeoutValue = 0xFFFFU;
AnnaBridge 189:f392fc9709a3 182 * @endcode
AnnaBridge 189:f392fc9709a3 183 *
AnnaBridge 189:f392fc9709a3 184 * @param config Pointer to the WDOG configuration structure.
AnnaBridge 189:f392fc9709a3 185 * @see wdog_config_t
AnnaBridge 189:f392fc9709a3 186 */
AnnaBridge 189:f392fc9709a3 187 void WDOG_GetDefaultConfig(wdog_config_t *config);
AnnaBridge 189:f392fc9709a3 188
AnnaBridge 189:f392fc9709a3 189 /*!
AnnaBridge 189:f392fc9709a3 190 * @brief Initializes the WDOG.
AnnaBridge 189:f392fc9709a3 191 *
AnnaBridge 189:f392fc9709a3 192 * This function initializes the WDOG. When called, the WDOG runs according to the configuration.
AnnaBridge 189:f392fc9709a3 193 * To reconfigure WDOG without forcing a reset first, enableUpdate must be set to true
AnnaBridge 189:f392fc9709a3 194 * in the configuration.
AnnaBridge 189:f392fc9709a3 195 *
AnnaBridge 189:f392fc9709a3 196 * This is an example.
AnnaBridge 189:f392fc9709a3 197 * @code
AnnaBridge 189:f392fc9709a3 198 * wdog_config_t config;
AnnaBridge 189:f392fc9709a3 199 * WDOG_GetDefaultConfig(&config);
AnnaBridge 189:f392fc9709a3 200 * config.timeoutValue = 0x7ffU;
AnnaBridge 189:f392fc9709a3 201 * config.enableUpdate = true;
AnnaBridge 189:f392fc9709a3 202 * WDOG_Init(wdog_base,&config);
AnnaBridge 189:f392fc9709a3 203 * @endcode
AnnaBridge 189:f392fc9709a3 204 *
AnnaBridge 189:f392fc9709a3 205 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 206 * @param config The configuration of WDOG
AnnaBridge 189:f392fc9709a3 207 */
AnnaBridge 189:f392fc9709a3 208 void WDOG_Init(WDOG_Type *base, const wdog_config_t *config);
AnnaBridge 189:f392fc9709a3 209
AnnaBridge 189:f392fc9709a3 210 /*!
AnnaBridge 189:f392fc9709a3 211 * @brief Shuts down the WDOG.
AnnaBridge 189:f392fc9709a3 212 *
AnnaBridge 189:f392fc9709a3 213 * This function shuts down the WDOG.
AnnaBridge 189:f392fc9709a3 214 * Ensure that the WDOG_STCTRLH.ALLOWUPDATE is 1 which indicates that the register update is enabled.
AnnaBridge 189:f392fc9709a3 215 */
AnnaBridge 189:f392fc9709a3 216 void WDOG_Deinit(WDOG_Type *base);
AnnaBridge 189:f392fc9709a3 217
AnnaBridge 189:f392fc9709a3 218 /*!
AnnaBridge 189:f392fc9709a3 219 * @brief Configures the WDOG functional test.
AnnaBridge 189:f392fc9709a3 220 *
AnnaBridge 189:f392fc9709a3 221 * This function is used to configure the WDOG functional test. When called, the WDOG goes into test mode
AnnaBridge 189:f392fc9709a3 222 * and runs according to the configuration.
AnnaBridge 189:f392fc9709a3 223 * Ensure that the WDOG_STCTRLH.ALLOWUPDATE is 1 which means that the register update is enabled.
AnnaBridge 189:f392fc9709a3 224 *
AnnaBridge 189:f392fc9709a3 225 * This is an example.
AnnaBridge 189:f392fc9709a3 226 * @code
AnnaBridge 189:f392fc9709a3 227 * wdog_test_config_t test_config;
AnnaBridge 189:f392fc9709a3 228 * test_config.testMode = kWDOG_QuickTest;
AnnaBridge 189:f392fc9709a3 229 * test_config.timeoutValue = 0xfffffu;
AnnaBridge 189:f392fc9709a3 230 * WDOG_SetTestModeConfig(wdog_base, &test_config);
AnnaBridge 189:f392fc9709a3 231 * @endcode
AnnaBridge 189:f392fc9709a3 232 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 233 * @param config The functional test configuration of WDOG
AnnaBridge 189:f392fc9709a3 234 */
AnnaBridge 189:f392fc9709a3 235 void WDOG_SetTestModeConfig(WDOG_Type *base, wdog_test_config_t *config);
AnnaBridge 189:f392fc9709a3 236
AnnaBridge 189:f392fc9709a3 237 /* @} */
AnnaBridge 189:f392fc9709a3 238
AnnaBridge 189:f392fc9709a3 239 /*!
AnnaBridge 189:f392fc9709a3 240 * @name WDOG Functional Operation
AnnaBridge 189:f392fc9709a3 241 * @{
AnnaBridge 189:f392fc9709a3 242 */
AnnaBridge 189:f392fc9709a3 243
AnnaBridge 189:f392fc9709a3 244 /*!
AnnaBridge 189:f392fc9709a3 245 * @brief Enables the WDOG module.
AnnaBridge 189:f392fc9709a3 246 *
AnnaBridge 189:f392fc9709a3 247 * This function write value into WDOG_STCTRLH register to enable the WDOG, it is a write-once register,
AnnaBridge 189:f392fc9709a3 248 * make sure that the WCT window is still open and this register has not been written in this WCT
AnnaBridge 189:f392fc9709a3 249 * while this function is called.
AnnaBridge 189:f392fc9709a3 250 *
AnnaBridge 189:f392fc9709a3 251 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 252 */
AnnaBridge 189:f392fc9709a3 253 static inline void WDOG_Enable(WDOG_Type *base)
AnnaBridge 189:f392fc9709a3 254 {
AnnaBridge 189:f392fc9709a3 255 base->STCTRLH |= WDOG_STCTRLH_WDOGEN_MASK;
AnnaBridge 189:f392fc9709a3 256 }
AnnaBridge 189:f392fc9709a3 257
AnnaBridge 189:f392fc9709a3 258 /*!
AnnaBridge 189:f392fc9709a3 259 * @brief Disables the WDOG module.
AnnaBridge 189:f392fc9709a3 260 *
AnnaBridge 189:f392fc9709a3 261 * This function writes a value into the WDOG_STCTRLH register to disable the WDOG. It is a write-once register.
AnnaBridge 189:f392fc9709a3 262 * Ensure that the WCT window is still open and that register has not been written to in this WCT
AnnaBridge 189:f392fc9709a3 263 * while the function is called.
AnnaBridge 189:f392fc9709a3 264 *
AnnaBridge 189:f392fc9709a3 265 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 266 */
AnnaBridge 189:f392fc9709a3 267 static inline void WDOG_Disable(WDOG_Type *base)
AnnaBridge 189:f392fc9709a3 268 {
AnnaBridge 189:f392fc9709a3 269 base->STCTRLH &= ~WDOG_STCTRLH_WDOGEN_MASK;
AnnaBridge 189:f392fc9709a3 270 }
AnnaBridge 189:f392fc9709a3 271
AnnaBridge 189:f392fc9709a3 272 /*!
AnnaBridge 189:f392fc9709a3 273 * @brief Enables the WDOG interrupt.
AnnaBridge 189:f392fc9709a3 274 *
AnnaBridge 189:f392fc9709a3 275 * This function writes a value into the WDOG_STCTRLH register to enable the WDOG interrupt. It is a write-once register.
AnnaBridge 189:f392fc9709a3 276 * Ensure that the WCT window is still open and the register has not been written to in this WCT
AnnaBridge 189:f392fc9709a3 277 * while the function is called.
AnnaBridge 189:f392fc9709a3 278 *
AnnaBridge 189:f392fc9709a3 279 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 280 * @param mask The interrupts to enable
AnnaBridge 189:f392fc9709a3 281 * The parameter can be combination of the following source if defined.
AnnaBridge 189:f392fc9709a3 282 * @arg kWDOG_InterruptEnable
AnnaBridge 189:f392fc9709a3 283 */
AnnaBridge 189:f392fc9709a3 284 static inline void WDOG_EnableInterrupts(WDOG_Type *base, uint32_t mask)
AnnaBridge 189:f392fc9709a3 285 {
AnnaBridge 189:f392fc9709a3 286 base->STCTRLH |= mask;
AnnaBridge 189:f392fc9709a3 287 }
AnnaBridge 189:f392fc9709a3 288
AnnaBridge 189:f392fc9709a3 289 /*!
AnnaBridge 189:f392fc9709a3 290 * @brief Disables the WDOG interrupt.
AnnaBridge 189:f392fc9709a3 291 *
AnnaBridge 189:f392fc9709a3 292 * This function writes a value into the WDOG_STCTRLH register to disable the WDOG interrupt. It is a write-once register.
AnnaBridge 189:f392fc9709a3 293 * Ensure that the WCT window is still open and the register has not been written to in this WCT
AnnaBridge 189:f392fc9709a3 294 * while the function is called.
AnnaBridge 189:f392fc9709a3 295 *
AnnaBridge 189:f392fc9709a3 296 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 297 * @param mask The interrupts to disable
AnnaBridge 189:f392fc9709a3 298 * The parameter can be combination of the following source if defined.
AnnaBridge 189:f392fc9709a3 299 * @arg kWDOG_InterruptEnable
AnnaBridge 189:f392fc9709a3 300 */
AnnaBridge 189:f392fc9709a3 301 static inline void WDOG_DisableInterrupts(WDOG_Type *base, uint32_t mask)
AnnaBridge 189:f392fc9709a3 302 {
AnnaBridge 189:f392fc9709a3 303 base->STCTRLH &= ~mask;
AnnaBridge 189:f392fc9709a3 304 }
AnnaBridge 189:f392fc9709a3 305
AnnaBridge 189:f392fc9709a3 306 /*!
AnnaBridge 189:f392fc9709a3 307 * @brief Gets the WDOG all status flags.
AnnaBridge 189:f392fc9709a3 308 *
AnnaBridge 189:f392fc9709a3 309 * This function gets all status flags.
AnnaBridge 189:f392fc9709a3 310 *
AnnaBridge 189:f392fc9709a3 311 * This is an example for getting the Running Flag.
AnnaBridge 189:f392fc9709a3 312 * @code
AnnaBridge 189:f392fc9709a3 313 * uint32_t status;
AnnaBridge 189:f392fc9709a3 314 * status = WDOG_GetStatusFlags (wdog_base) & kWDOG_RunningFlag;
AnnaBridge 189:f392fc9709a3 315 * @endcode
AnnaBridge 189:f392fc9709a3 316 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 317 * @return State of the status flag: asserted (true) or not-asserted (false).@see _wdog_status_flags_t
AnnaBridge 189:f392fc9709a3 318 * - true: a related status flag has been set.
AnnaBridge 189:f392fc9709a3 319 * - false: a related status flag is not set.
AnnaBridge 189:f392fc9709a3 320 */
AnnaBridge 189:f392fc9709a3 321 uint32_t WDOG_GetStatusFlags(WDOG_Type *base);
AnnaBridge 189:f392fc9709a3 322
AnnaBridge 189:f392fc9709a3 323 /*!
AnnaBridge 189:f392fc9709a3 324 * @brief Clears the WDOG flag.
AnnaBridge 189:f392fc9709a3 325 *
AnnaBridge 189:f392fc9709a3 326 * This function clears the WDOG status flag.
AnnaBridge 189:f392fc9709a3 327 *
AnnaBridge 189:f392fc9709a3 328 * This is an example for clearing the timeout (interrupt) flag.
AnnaBridge 189:f392fc9709a3 329 * @code
AnnaBridge 189:f392fc9709a3 330 * WDOG_ClearStatusFlags(wdog_base,kWDOG_TimeoutFlag);
AnnaBridge 189:f392fc9709a3 331 * @endcode
AnnaBridge 189:f392fc9709a3 332 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 333 * @param mask The status flags to clear.
AnnaBridge 189:f392fc9709a3 334 * The parameter could be any combination of the following values.
AnnaBridge 189:f392fc9709a3 335 * kWDOG_TimeoutFlag
AnnaBridge 189:f392fc9709a3 336 */
AnnaBridge 189:f392fc9709a3 337 void WDOG_ClearStatusFlags(WDOG_Type *base, uint32_t mask);
AnnaBridge 189:f392fc9709a3 338
AnnaBridge 189:f392fc9709a3 339 /*!
AnnaBridge 189:f392fc9709a3 340 * @brief Sets the WDOG timeout value.
AnnaBridge 189:f392fc9709a3 341 *
AnnaBridge 189:f392fc9709a3 342 * This function sets the timeout value.
AnnaBridge 189:f392fc9709a3 343 * It should be ensured that the time-out value for the WDOG is always greater than
AnnaBridge 189:f392fc9709a3 344 * 2xWCT time + 20 bus clock cycles.
AnnaBridge 189:f392fc9709a3 345 * This function writes a value into WDOG_TOVALH and WDOG_TOVALL registers which are wirte-once.
AnnaBridge 189:f392fc9709a3 346 * Ensure the WCT window is still open and the two registers have not been written to in this WCT
AnnaBridge 189:f392fc9709a3 347 * while the function is called.
AnnaBridge 189:f392fc9709a3 348 *
AnnaBridge 189:f392fc9709a3 349 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 350 * @param timeoutCount WDOG timeout value; count of WDOG clock tick.
AnnaBridge 189:f392fc9709a3 351 */
AnnaBridge 189:f392fc9709a3 352 static inline void WDOG_SetTimeoutValue(WDOG_Type *base, uint32_t timeoutCount)
AnnaBridge 189:f392fc9709a3 353 {
AnnaBridge 189:f392fc9709a3 354 base->TOVALH = (uint16_t)((timeoutCount >> 16U) & 0xFFFFU);
AnnaBridge 189:f392fc9709a3 355 base->TOVALL = (uint16_t)((timeoutCount)&0xFFFFU);
AnnaBridge 189:f392fc9709a3 356 }
AnnaBridge 189:f392fc9709a3 357
AnnaBridge 189:f392fc9709a3 358 /*!
AnnaBridge 189:f392fc9709a3 359 * @brief Sets the WDOG window value.
AnnaBridge 189:f392fc9709a3 360 *
AnnaBridge 189:f392fc9709a3 361 * This function sets the WDOG window value.
AnnaBridge 189:f392fc9709a3 362 * This function writes a value into WDOG_WINH and WDOG_WINL registers which are wirte-once.
AnnaBridge 189:f392fc9709a3 363 * Ensure the WCT window is still open and the two registers have not been written to in this WCT
AnnaBridge 189:f392fc9709a3 364 * while the function is called.
AnnaBridge 189:f392fc9709a3 365 *
AnnaBridge 189:f392fc9709a3 366 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 367 * @param windowValue WDOG window value.
AnnaBridge 189:f392fc9709a3 368 */
AnnaBridge 189:f392fc9709a3 369 static inline void WDOG_SetWindowValue(WDOG_Type *base, uint32_t windowValue)
AnnaBridge 189:f392fc9709a3 370 {
AnnaBridge 189:f392fc9709a3 371 base->WINH = (uint16_t)((windowValue >> 16U) & 0xFFFFU);
AnnaBridge 189:f392fc9709a3 372 base->WINL = (uint16_t)((windowValue)&0xFFFFU);
AnnaBridge 189:f392fc9709a3 373 }
AnnaBridge 189:f392fc9709a3 374
AnnaBridge 189:f392fc9709a3 375 /*!
AnnaBridge 189:f392fc9709a3 376 * @brief Unlocks the WDOG register written.
AnnaBridge 189:f392fc9709a3 377 *
AnnaBridge 189:f392fc9709a3 378 * This function unlocks the WDOG register written.
AnnaBridge 189:f392fc9709a3 379 * Before starting the unlock sequence and following congfiguration, disable the global interrupts.
AnnaBridge 189:f392fc9709a3 380 * Otherwise, an interrupt may invalidate the unlocking sequence and the WCT may expire.
AnnaBridge 189:f392fc9709a3 381 * After the configuration finishes, re-enable the global interrupts.
AnnaBridge 189:f392fc9709a3 382 *
AnnaBridge 189:f392fc9709a3 383 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 384 */
AnnaBridge 189:f392fc9709a3 385 static inline void WDOG_Unlock(WDOG_Type *base)
AnnaBridge 189:f392fc9709a3 386 {
AnnaBridge 189:f392fc9709a3 387 base->UNLOCK = WDOG_FIRST_WORD_OF_UNLOCK;
AnnaBridge 189:f392fc9709a3 388 base->UNLOCK = WDOG_SECOND_WORD_OF_UNLOCK;
AnnaBridge 189:f392fc9709a3 389 }
AnnaBridge 189:f392fc9709a3 390
AnnaBridge 189:f392fc9709a3 391 /*!
AnnaBridge 189:f392fc9709a3 392 * @brief Refreshes the WDOG timer.
AnnaBridge 189:f392fc9709a3 393 *
AnnaBridge 189:f392fc9709a3 394 * This function feeds the WDOG.
AnnaBridge 189:f392fc9709a3 395 * This function should be called before the WDOG timer is in timeout. Otherwise, a reset is asserted.
AnnaBridge 189:f392fc9709a3 396 *
AnnaBridge 189:f392fc9709a3 397 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 398 */
AnnaBridge 189:f392fc9709a3 399 void WDOG_Refresh(WDOG_Type *base);
AnnaBridge 189:f392fc9709a3 400
AnnaBridge 189:f392fc9709a3 401 /*!
AnnaBridge 189:f392fc9709a3 402 * @brief Gets the WDOG reset count.
AnnaBridge 189:f392fc9709a3 403 *
AnnaBridge 189:f392fc9709a3 404 * This function gets the WDOG reset count value.
AnnaBridge 189:f392fc9709a3 405 *
AnnaBridge 189:f392fc9709a3 406 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 407 * @return WDOG reset count value.
AnnaBridge 189:f392fc9709a3 408 */
AnnaBridge 189:f392fc9709a3 409 static inline uint16_t WDOG_GetResetCount(WDOG_Type *base)
AnnaBridge 189:f392fc9709a3 410 {
AnnaBridge 189:f392fc9709a3 411 return base->RSTCNT;
AnnaBridge 189:f392fc9709a3 412 }
AnnaBridge 189:f392fc9709a3 413 /*!
AnnaBridge 189:f392fc9709a3 414 * @brief Clears the WDOG reset count.
AnnaBridge 189:f392fc9709a3 415 *
AnnaBridge 189:f392fc9709a3 416 * This function clears the WDOG reset count value.
AnnaBridge 189:f392fc9709a3 417 *
AnnaBridge 189:f392fc9709a3 418 * @param base WDOG peripheral base address
AnnaBridge 189:f392fc9709a3 419 */
AnnaBridge 189:f392fc9709a3 420 static inline void WDOG_ClearResetCount(WDOG_Type *base)
AnnaBridge 189:f392fc9709a3 421 {
AnnaBridge 189:f392fc9709a3 422 base->RSTCNT |= UINT16_MAX;
AnnaBridge 189:f392fc9709a3 423 }
AnnaBridge 189:f392fc9709a3 424
AnnaBridge 189:f392fc9709a3 425 /*@}*/
AnnaBridge 189:f392fc9709a3 426
AnnaBridge 189:f392fc9709a3 427 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 428 }
AnnaBridge 189:f392fc9709a3 429 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 430
AnnaBridge 189:f392fc9709a3 431 /*! @}*/
AnnaBridge 189:f392fc9709a3 432
AnnaBridge 189:f392fc9709a3 433 #endif /* _FSL_WDOG_H_ */