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