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_MAX32630FTHR/TOOLCHAIN_IAR/wdt2.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 171:3a7713b1edbc 1 /**
AnnaBridge 171:3a7713b1edbc 2 * @file
AnnaBridge 171:3a7713b1edbc 3 * @brief WDT2 peripheral module API.
AnnaBridge 171:3a7713b1edbc 4 */
AnnaBridge 171:3a7713b1edbc 5 /* ****************************************************************************
AnnaBridge 171:3a7713b1edbc 6 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
AnnaBridge 171:3a7713b1edbc 7 *
AnnaBridge 171:3a7713b1edbc 8 * Permission is hereby granted, free of charge, to any person obtaining a
AnnaBridge 171:3a7713b1edbc 9 * copy of this software and associated documentation files (the "Software"),
AnnaBridge 171:3a7713b1edbc 10 * to deal in the Software without restriction, including without limitation
AnnaBridge 171:3a7713b1edbc 11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
AnnaBridge 171:3a7713b1edbc 12 * and/or sell copies of the Software, and to permit persons to whom the
AnnaBridge 171:3a7713b1edbc 13 * Software is furnished to do so, subject to the following conditions:
AnnaBridge 171:3a7713b1edbc 14 *
AnnaBridge 171:3a7713b1edbc 15 * The above copyright notice and this permission notice shall be included
AnnaBridge 171:3a7713b1edbc 16 * in all copies or substantial portions of the Software.
AnnaBridge 171:3a7713b1edbc 17 *
AnnaBridge 171:3a7713b1edbc 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
AnnaBridge 171:3a7713b1edbc 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
AnnaBridge 171:3a7713b1edbc 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
AnnaBridge 171:3a7713b1edbc 21 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
AnnaBridge 171:3a7713b1edbc 22 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
AnnaBridge 171:3a7713b1edbc 23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
AnnaBridge 171:3a7713b1edbc 24 * OTHER DEALINGS IN THE SOFTWARE.
AnnaBridge 171:3a7713b1edbc 25 *
AnnaBridge 171:3a7713b1edbc 26 * Except as contained in this notice, the name of Maxim Integrated
AnnaBridge 171:3a7713b1edbc 27 * Products, Inc. shall not be used except as stated in the Maxim Integrated
AnnaBridge 171:3a7713b1edbc 28 * Products, Inc. Branding Policy.
AnnaBridge 171:3a7713b1edbc 29 *
AnnaBridge 171:3a7713b1edbc 30 * The mere transfer of this software does not imply any licenses
AnnaBridge 171:3a7713b1edbc 31 * of trade secrets, proprietary technology, copyrights, patents,
AnnaBridge 171:3a7713b1edbc 32 * trademarks, maskwork rights, or any other form of intellectual
AnnaBridge 171:3a7713b1edbc 33 * property whatsoever. Maxim Integrated Products, Inc. retains all
AnnaBridge 171:3a7713b1edbc 34 * ownership rights.
AnnaBridge 171:3a7713b1edbc 35 *
AnnaBridge 171:3a7713b1edbc 36 * $Date: 2016-10-10 19:54:34 -0500 (Mon, 10 Oct 2016) $
AnnaBridge 171:3a7713b1edbc 37 * $Revision: 24678 $
AnnaBridge 171:3a7713b1edbc 38 *
AnnaBridge 171:3a7713b1edbc 39 **************************************************************************** */
AnnaBridge 171:3a7713b1edbc 40
AnnaBridge 171:3a7713b1edbc 41 /* Define to prevent redundant inclusion */
AnnaBridge 171:3a7713b1edbc 42 #ifndef _WDT2_H
AnnaBridge 171:3a7713b1edbc 43 #define _WDT2_H
AnnaBridge 171:3a7713b1edbc 44
AnnaBridge 171:3a7713b1edbc 45 /* **** Includes **** */
AnnaBridge 171:3a7713b1edbc 46 #include "mxc_config.h"
AnnaBridge 171:3a7713b1edbc 47 #include "wdt2_regs.h"
AnnaBridge 171:3a7713b1edbc 48 #include "mxc_assert.h"
AnnaBridge 171:3a7713b1edbc 49
AnnaBridge 171:3a7713b1edbc 50 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 51 extern "C" {
AnnaBridge 171:3a7713b1edbc 52 #endif
AnnaBridge 171:3a7713b1edbc 53
AnnaBridge 171:3a7713b1edbc 54 /**
AnnaBridge 171:3a7713b1edbc 55 * @ingroup wdttimers
AnnaBridge 171:3a7713b1edbc 56 * @defgroup wdt2 Watch Dog Timer 2
AnnaBridge 171:3a7713b1edbc 57 * @brief WDT2 configuration and control API.
AnnaBridge 171:3a7713b1edbc 58 * @{
AnnaBridge 171:3a7713b1edbc 59 */
AnnaBridge 171:3a7713b1edbc 60
AnnaBridge 171:3a7713b1edbc 61 /**
AnnaBridge 171:3a7713b1edbc 62 * @def Definition to clear all WDT2 flags
AnnaBridge 171:3a7713b1edbc 63 */
AnnaBridge 171:3a7713b1edbc 64 #define WDT2_FLAGS_CLEAR_ALL (MXC_F_WDT2_FLAGS_TIMEOUT | MXC_F_WDT2_FLAGS_RESET_OUT)
AnnaBridge 171:3a7713b1edbc 65 /**
AnnaBridge 171:3a7713b1edbc 66 * Enumeration type to select the Watchdog Timer's Period
AnnaBridge 171:3a7713b1edbc 67 */
AnnaBridge 171:3a7713b1edbc 68 typedef enum {
AnnaBridge 171:3a7713b1edbc 69 WDT2_PERIOD_2_25_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_25_NANO_CLKS, /**< \f$ 2^{25}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 70 WDT2_PERIOD_2_24_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_24_NANO_CLKS, /**< \f$ 2^{24}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 71 WDT2_PERIOD_2_23_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_23_NANO_CLKS, /**< \f$ 2^{23}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 72 WDT2_PERIOD_2_22_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_22_NANO_CLKS, /**< \f$ 2^{22}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 73 WDT2_PERIOD_2_21_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_21_NANO_CLKS, /**< \f$ 2^{21}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 74 WDT2_PERIOD_2_20_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_20_NANO_CLKS, /**< \f$ 2^{20}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 75 WDT2_PERIOD_2_19_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_19_NANO_CLKS, /**< \f$ 2^{19}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 76 WDT2_PERIOD_2_18_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_18_NANO_CLKS, /**< \f$ 2^{18}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 77 WDT2_PERIOD_2_17_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_17_NANO_CLKS, /**< \f$ 2^{17}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 78 WDT2_PERIOD_2_16_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_16_NANO_CLKS, /**< \f$ 2^{16}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 79 WDT2_PERIOD_2_15_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_15_NANO_CLKS, /**< \f$ 2^{15}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 80 WDT2_PERIOD_2_14_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_14_NANO_CLKS, /**< \f$ 2^{14}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 81 WDT2_PERIOD_2_13_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_13_NANO_CLKS, /**< \f$ 2^{13}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 82 WDT2_PERIOD_2_12_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_12_NANO_CLKS, /**< \f$ 2^{12}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 83 WDT2_PERIOD_2_11_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_11_NANO_CLKS, /**< \f$ 2^{11}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 84 WDT2_PERIOD_2_10_CLKS = MXC_V_WDT2_CTRL_INT_PERIOD_2_10_NANO_CLKS, /**< \f$ 2^{10}\f$ Nano Ring clocks. */
AnnaBridge 171:3a7713b1edbc 85 WDT2_PERIOD_MAX /**< Maximum Period is Max - 1 */
AnnaBridge 171:3a7713b1edbc 86 } wdt2_period_t;
AnnaBridge 171:3a7713b1edbc 87
AnnaBridge 171:3a7713b1edbc 88
AnnaBridge 171:3a7713b1edbc 89 /**
AnnaBridge 171:3a7713b1edbc 90 * @brief Initializes the NanoRing for the watchdog clock and sets watchdog
AnnaBridge 171:3a7713b1edbc 91 * in a known disabled state
AnnaBridge 171:3a7713b1edbc 92 * @param runInSleep If non-zero, the WDT2 operates in Sleep Modes for
AnnaBridge 171:3a7713b1edbc 93 * the device, 0 disables the WDT2 during Sleep Modes.
AnnaBridge 171:3a7713b1edbc 94 * @param unlock_key The WDT2 unlock key value, use
AnnaBridge 171:3a7713b1edbc 95 * #MXC_V_WDT2_UNLOCK_KEY
AnnaBridge 171:3a7713b1edbc 96 *
AnnaBridge 171:3a7713b1edbc 97 * @retval #E_NO_ERROR Watchdog Timer initialized as requested
AnnaBridge 171:3a7713b1edbc 98 * @retval #E_BAD_STATE Invalid unlock_key, WDT2 failed to unlock.
AnnaBridge 171:3a7713b1edbc 99 */
AnnaBridge 171:3a7713b1edbc 100 int WDT2_Init(uint8_t runInSleep, uint8_t unlock_key);
AnnaBridge 171:3a7713b1edbc 101
AnnaBridge 171:3a7713b1edbc 102 /**
AnnaBridge 171:3a7713b1edbc 103 * @brief Configures and enables the wake-up timeout for the watchdog
AnnaBridge 171:3a7713b1edbc 104 * specified.
AnnaBridge 171:3a7713b1edbc 105 *
AnnaBridge 171:3a7713b1edbc 106 * @param int_period Interrupt period.
AnnaBridge 171:3a7713b1edbc 107 * @param unlock_key Key to unlock watchdog.
AnnaBridge 171:3a7713b1edbc 108 *
AnnaBridge 171:3a7713b1edbc 109 * @retval #E_NO_ERROR WDT2 Interrupt period enabled with the int_period
AnnaBridge 171:3a7713b1edbc 110 * time.
AnnaBridge 171:3a7713b1edbc 111 * @retval #E_INVALID Requested Period is greater than the maximum
AnnaBridge 171:3a7713b1edbc 112 * supported
AnnaBridge 171:3a7713b1edbc 113 * @retval #E_BAD_STATE Invalid unlock_key, WDT2 failed to unlock.
AnnaBridge 171:3a7713b1edbc 114 */
AnnaBridge 171:3a7713b1edbc 115 int WDT2_EnableWakeUp(wdt2_period_t int_period, uint8_t unlock_key);
AnnaBridge 171:3a7713b1edbc 116
AnnaBridge 171:3a7713b1edbc 117 /**
AnnaBridge 171:3a7713b1edbc 118 * @brief Disables the interrupt timeout for the watchdog specified.
AnnaBridge 171:3a7713b1edbc 119 *
AnnaBridge 171:3a7713b1edbc 120 * @param unlock_key Key to unlock watchdog.
AnnaBridge 171:3a7713b1edbc 121 *
AnnaBridge 171:3a7713b1edbc 122 * @retval #E_NO_ERROR Wakeup disabled.
AnnaBridge 171:3a7713b1edbc 123 * @retval #E_BAD_STATE Invalid unlock_key, WDT2 failed to unlock.
AnnaBridge 171:3a7713b1edbc 124 */
AnnaBridge 171:3a7713b1edbc 125 int WDT2_DisableWakeUp(uint8_t unlock_key);
AnnaBridge 171:3a7713b1edbc 126
AnnaBridge 171:3a7713b1edbc 127 /**
AnnaBridge 171:3a7713b1edbc 128 * @brief Configures and enables the reset timeout for the watchdog
AnnaBridge 171:3a7713b1edbc 129 * specified.
AnnaBridge 171:3a7713b1edbc 130 *
AnnaBridge 171:3a7713b1edbc 131 * @param rst_period Reset period.
AnnaBridge 171:3a7713b1edbc 132 * @param unlock_key Key to unlock watchdog.
AnnaBridge 171:3a7713b1edbc 133 *
AnnaBridge 171:3a7713b1edbc 134 * @retval #E_NO_ERROR Reset timeout enabled with the rst_period time.
AnnaBridge 171:3a7713b1edbc 135 * @retval #E_INVALID Requested Period is greater than the maximum
AnnaBridge 171:3a7713b1edbc 136 * supported
AnnaBridge 171:3a7713b1edbc 137 * @retval #E_BAD_STATE Invalid unlock_key, WDT2 failed to unlock.
AnnaBridge 171:3a7713b1edbc 138 */
AnnaBridge 171:3a7713b1edbc 139 int WDT2_EnableReset(wdt2_period_t rst_period, uint8_t unlock_key);
AnnaBridge 171:3a7713b1edbc 140
AnnaBridge 171:3a7713b1edbc 141 /**
AnnaBridge 171:3a7713b1edbc 142 * @brief Disables the reset timeout for the watchdog specified.
AnnaBridge 171:3a7713b1edbc 143 *
AnnaBridge 171:3a7713b1edbc 144 * @param unlock_key Key to unlock watchdog.
AnnaBridge 171:3a7713b1edbc 145 *
AnnaBridge 171:3a7713b1edbc 146 * @retval #E_NO_ERROR Reset disabled.
AnnaBridge 171:3a7713b1edbc 147 * @retval #E_BAD_STATE Invalid unlock_key, WDT2 failed to unlock.
AnnaBridge 171:3a7713b1edbc 148 */
AnnaBridge 171:3a7713b1edbc 149 int WDT2_DisableReset(uint8_t unlock_key);
AnnaBridge 171:3a7713b1edbc 150
AnnaBridge 171:3a7713b1edbc 151 /**
AnnaBridge 171:3a7713b1edbc 152 * @brief Gets the watchdog flags
AnnaBridge 171:3a7713b1edbc 153 *
AnnaBridge 171:3a7713b1edbc 154 * @retval 0 No flags set.
AnnaBridge 171:3a7713b1edbc 155 * @retval non-zero The WDT2 interrupt flags that are
AnnaBridge 171:3a7713b1edbc 156 * set, see @ref WDT2_FLAGS_Register "WDT2_FLAGS
AnnaBridge 171:3a7713b1edbc 157 * register".
AnnaBridge 171:3a7713b1edbc 158 */
AnnaBridge 171:3a7713b1edbc 159 __STATIC_INLINE uint32_t WDT2_GetFlags(void)
AnnaBridge 171:3a7713b1edbc 160 {
AnnaBridge 171:3a7713b1edbc 161 return (MXC_WDT2->flags);
AnnaBridge 171:3a7713b1edbc 162 }
AnnaBridge 171:3a7713b1edbc 163
AnnaBridge 171:3a7713b1edbc 164 /**
AnnaBridge 171:3a7713b1edbc 165 * @brief Clears the watchdog flags based on the @p mask.
AnnaBridge 171:3a7713b1edbc 166 *
AnnaBridge 171:3a7713b1edbc 167 * @param mask bits to clear
AnnaBridge 171:3a7713b1edbc 168 */
AnnaBridge 171:3a7713b1edbc 169 __STATIC_INLINE void WDT2_ClearFlags(uint32_t mask)
AnnaBridge 171:3a7713b1edbc 170 {
AnnaBridge 171:3a7713b1edbc 171 MXC_WDT2->flags = mask;
AnnaBridge 171:3a7713b1edbc 172 }
AnnaBridge 171:3a7713b1edbc 173
AnnaBridge 171:3a7713b1edbc 174 /**
AnnaBridge 171:3a7713b1edbc 175 * @brief Starts the watchdog specified.
AnnaBridge 171:3a7713b1edbc 176 *
AnnaBridge 171:3a7713b1edbc 177 * @param unlock_key Key to unlock watchdog.
AnnaBridge 171:3a7713b1edbc 178 *
AnnaBridge 171:3a7713b1edbc 179 * @retval #E_NO_ERROR WDT2 started.
AnnaBridge 171:3a7713b1edbc 180 * @retval #E_BAD_STATE Invalid unlock_key, WDT2 failed to unlock.
AnnaBridge 171:3a7713b1edbc 181 */
AnnaBridge 171:3a7713b1edbc 182 int WDT2_Start(uint8_t unlock_key);
AnnaBridge 171:3a7713b1edbc 183
AnnaBridge 171:3a7713b1edbc 184 /**
AnnaBridge 171:3a7713b1edbc 185 * @brief Feeds the watchdog specified.
AnnaBridge 171:3a7713b1edbc 186 *
AnnaBridge 171:3a7713b1edbc 187 * @retval #E_NO_ERROR WDT2 reset successfully.
AnnaBridge 171:3a7713b1edbc 188 */
AnnaBridge 171:3a7713b1edbc 189 void WDT2_Reset(void);
AnnaBridge 171:3a7713b1edbc 190
AnnaBridge 171:3a7713b1edbc 191 /**
AnnaBridge 171:3a7713b1edbc 192 * @brief Stops the WatchDog Timer 2.
AnnaBridge 171:3a7713b1edbc 193 *
AnnaBridge 171:3a7713b1edbc 194 * @param unlock_key Key to unlock watchdog.
AnnaBridge 171:3a7713b1edbc 195 *
AnnaBridge 171:3a7713b1edbc 196 * @retval #E_NO_ERROR WDT2 stopped.
AnnaBridge 171:3a7713b1edbc 197 * @retval #E_BAD_STATE Invalid unlock_key, WDT2 failed to unlock.
AnnaBridge 171:3a7713b1edbc 198 */
AnnaBridge 171:3a7713b1edbc 199 int WDT2_Stop(uint8_t unlock_key);
AnnaBridge 171:3a7713b1edbc 200
AnnaBridge 171:3a7713b1edbc 201 /**
AnnaBridge 171:3a7713b1edbc 202 * @brief Determines if the watchdog is running
AnnaBridge 171:3a7713b1edbc 203 *
AnnaBridge 171:3a7713b1edbc 204 * @retval 0 Inactive
AnnaBridge 171:3a7713b1edbc 205 * @retval non-zero Active
AnnaBridge 171:3a7713b1edbc 206 */
AnnaBridge 171:3a7713b1edbc 207 __STATIC_INLINE int WDT2_IsActive(void)
AnnaBridge 171:3a7713b1edbc 208 {
AnnaBridge 171:3a7713b1edbc 209 return (!!(MXC_WDT2->ctrl & MXC_F_WDT2_CTRL_EN_TIMER));
AnnaBridge 171:3a7713b1edbc 210 }
AnnaBridge 171:3a7713b1edbc 211
AnnaBridge 171:3a7713b1edbc 212 /**@} end of group wdt2*/
AnnaBridge 171:3a7713b1edbc 213
AnnaBridge 171:3a7713b1edbc 214 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 215 }
AnnaBridge 171:3a7713b1edbc 216 #endif
AnnaBridge 171:3a7713b1edbc 217
AnnaBridge 171:3a7713b1edbc 218 #endif /* _WDT_H */