PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/targets/TARGET_Maxim/TARGET_MAX32630/mxc/wdt.h@1:b36bbc1c6d27, 2020-04-11 (annotated)

Committer:
demayer
Date:
Sat Apr 11 08:15:48 2020 +0000
Revision:
1:b36bbc1c6d27
Parent:
0:6bf0743ece18 
IMU-library in .h und .cpp file aufgeteilt

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1 /**
demayer 0:6bf0743ece18 2 * @file
demayer 0:6bf0743ece18 3 * @brief This is the high level API for the watchdog timer interface module
demayer 0:6bf0743ece18 4 */
demayer 0:6bf0743ece18 5 /* ****************************************************************************
demayer 0:6bf0743ece18 6 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
demayer 0:6bf0743ece18 7 *
demayer 0:6bf0743ece18 8 * Permission is hereby granted, free of charge, to any person obtaining a
demayer 0:6bf0743ece18 9 * copy of this software and associated documentation files (the "Software"),
demayer 0:6bf0743ece18 10 * to deal in the Software without restriction, including without limitation
demayer 0:6bf0743ece18 11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
demayer 0:6bf0743ece18 12 * and/or sell copies of the Software, and to permit persons to whom the
demayer 0:6bf0743ece18 13 * Software is furnished to do so, subject to the following conditions:
demayer 0:6bf0743ece18 14 *
demayer 0:6bf0743ece18 15 * The above copyright notice and this permission notice shall be included
demayer 0:6bf0743ece18 16 * in all copies or substantial portions of the Software.
demayer 0:6bf0743ece18 17 *
demayer 0:6bf0743ece18 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
demayer 0:6bf0743ece18 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
demayer 0:6bf0743ece18 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
demayer 0:6bf0743ece18 21 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
demayer 0:6bf0743ece18 22 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
demayer 0:6bf0743ece18 23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
demayer 0:6bf0743ece18 24 * OTHER DEALINGS IN THE SOFTWARE.
demayer 0:6bf0743ece18 25 *
demayer 0:6bf0743ece18 26 * Except as contained in this notice, the name of Maxim Integrated
demayer 0:6bf0743ece18 27 * Products, Inc. shall not be used except as stated in the Maxim Integrated
demayer 0:6bf0743ece18 28 * Products, Inc. Branding Policy.
demayer 0:6bf0743ece18 29 *
demayer 0:6bf0743ece18 30 * The mere transfer of this software does not imply any licenses
demayer 0:6bf0743ece18 31 * of trade secrets, proprietary technology, copyrights, patents,
demayer 0:6bf0743ece18 32 * trademarks, maskwork rights, or any other form of intellectual
demayer 0:6bf0743ece18 33 * property whatsoever. Maxim Integrated Products, Inc. retains all
demayer 0:6bf0743ece18 34 * ownership rights.
demayer 0:6bf0743ece18 35 *
demayer 0:6bf0743ece18 36 * $Date: 2016-10-10 19:53:06 -0500 (Mon, 10 Oct 2016) $
demayer 0:6bf0743ece18 37 * $Revision: 24677 $
demayer 0:6bf0743ece18 38 *
demayer 0:6bf0743ece18 39 **************************************************************************** */
demayer 0:6bf0743ece18 40
demayer 0:6bf0743ece18 41 /* Define to prevent redundant inclusion */
demayer 0:6bf0743ece18 42 #ifndef _WDT_H
demayer 0:6bf0743ece18 43 #define _WDT_H
demayer 0:6bf0743ece18 44
demayer 0:6bf0743ece18 45 /* **** Includes **** */
demayer 0:6bf0743ece18 46 #include "mxc_config.h"
demayer 0:6bf0743ece18 47 #include "wdt_regs.h"
demayer 0:6bf0743ece18 48 #include "mxc_assert.h"
demayer 0:6bf0743ece18 49 #include "mxc_sys.h"
demayer 0:6bf0743ece18 50
demayer 0:6bf0743ece18 51 #ifdef __cplusplus
demayer 0:6bf0743ece18 52 extern "C" {
demayer 0:6bf0743ece18 53 #endif
demayer 0:6bf0743ece18 54 /**
demayer 0:6bf0743ece18 55 * @ingroup periphlibs
demayer 0:6bf0743ece18 56 * @defgroup wdttimers Watch Dog Timers
demayer 0:6bf0743ece18 57 * @brief Watch Dog Timer High Level APIs.
demayer 0:6bf0743ece18 58 */
demayer 0:6bf0743ece18 59 /**
demayer 0:6bf0743ece18 60 * @ingroup wdttimers
demayer 0:6bf0743ece18 61 * @defgroup wdt0 Watch Dog Timer 0/1
demayer 0:6bf0743ece18 62 * @brief WDT0/WDT1 configuration and control API.
demayer 0:6bf0743ece18 63 * @{
demayer 0:6bf0743ece18 64 */
demayer 0:6bf0743ece18 65
demayer 0:6bf0743ece18 66 /**
demayer 0:6bf0743ece18 67 * Definition used for clearing all of the WDT instances flags for Timeout, Pre-Window and Reset Out.
demayer 0:6bf0743ece18 68 */
demayer 0:6bf0743ece18 69 #define WDT_FLAGS_CLEAR_ALL (MXC_F_WDT_FLAGS_TIMEOUT| MXC_F_WDT_FLAGS_PRE_WIN | MXC_F_WDT_FLAGS_RESET_OUT)
demayer 0:6bf0743ece18 70 /**
demayer 0:6bf0743ece18 71 * Enumeration type to define the Watchdog Timer's Period
demayer 0:6bf0743ece18 72 */
demayer 0:6bf0743ece18 73 typedef enum {
demayer 0:6bf0743ece18 74 WDT_PERIOD_2_31_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_31_CLKS, /**< \f$ 2^{31} \f$ WDT clocks. */
demayer 0:6bf0743ece18 75 WDT_PERIOD_2_30_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_30_CLKS, /**< \f$ 2^{30} \f$ WDT clocks. */
demayer 0:6bf0743ece18 76 WDT_PERIOD_2_29_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_29_CLKS, /**< \f$ 2^{29} \f$ WDT clocks. */
demayer 0:6bf0743ece18 77 WDT_PERIOD_2_28_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_28_CLKS, /**< \f$ 2^{28} \f$ WDT clocks. */
demayer 0:6bf0743ece18 78 WDT_PERIOD_2_27_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_27_CLKS, /**< \f$ 2^{27} \f$ WDT clocks. */
demayer 0:6bf0743ece18 79 WDT_PERIOD_2_26_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_26_CLKS, /**< \f$ 2^{26} \f$ WDT clocks. */
demayer 0:6bf0743ece18 80 WDT_PERIOD_2_25_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_25_CLKS, /**< \f$ 2^{25} \f$ WDT clocks. */
demayer 0:6bf0743ece18 81 WDT_PERIOD_2_24_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_24_CLKS, /**< \f$ 2^{24} \f$ WDT clocks. */
demayer 0:6bf0743ece18 82 WDT_PERIOD_2_23_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_23_CLKS, /**< \f$ 2^{23} \f$ WDT clocks. */
demayer 0:6bf0743ece18 83 WDT_PERIOD_2_22_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_22_CLKS, /**< \f$ 2^{22} \f$ WDT clocks. */
demayer 0:6bf0743ece18 84 WDT_PERIOD_2_21_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_21_CLKS, /**< \f$ 2^{21} \f$ WDT clocks. */
demayer 0:6bf0743ece18 85 WDT_PERIOD_2_20_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_20_CLKS, /**< \f$ 2^{20} \f$ WDT clocks. */
demayer 0:6bf0743ece18 86 WDT_PERIOD_2_19_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_19_CLKS, /**< \f$ 2^{19} \f$ WDT clocks. */
demayer 0:6bf0743ece18 87 WDT_PERIOD_2_18_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_18_CLKS, /**< \f$ 2^{18} \f$ WDT clocks. */
demayer 0:6bf0743ece18 88 WDT_PERIOD_2_17_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_17_CLKS, /**< \f$ 2^{17} \f$ WDT clocks. */
demayer 0:6bf0743ece18 89 WDT_PERIOD_2_16_CLKS = MXC_V_WDT_CTRL_INT_PERIOD_2_16_CLKS, /**< \f$ 2^{16} \f$ WDT clocks. */
demayer 0:6bf0743ece18 90 WDT_PERIOD_MAX /**< Maximum Period is Max - 1 */
demayer 0:6bf0743ece18 91 } wdt_period_t;
demayer 0:6bf0743ece18 92
demayer 0:6bf0743ece18 93 /**
demayer 0:6bf0743ece18 94 * @brief Initializes system level clocks and sets watchdog in a known disabled state
demayer 0:6bf0743ece18 95 * @note The clk_scale in cfg is only used if the system clock is selected for clk.
demayer 0:6bf0743ece18 96 *
demayer 0:6bf0743ece18 97 * @param wdt Pointer to the Watchdog Timer Instance
demayer 0:6bf0743ece18 98 * @param cfg Watchdog system configuration, see sys_cfg_wdt_t.
demayer 0:6bf0743ece18 99 * @param unlock_key Watchdog unlock key
demayer 0:6bf0743ece18 100 *
demayer 0:6bf0743ece18 101 * @retval #E_NO_ERROR Watchdog Timer initialized as requested
demayer 0:6bf0743ece18 102 * @retval #E_NULL_PTR NULL pointer for Watchdog Timer Instance or Configuration parameters.
demayer 0:6bf0743ece18 103 * @retval #E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
demayer 0:6bf0743ece18 104 */
demayer 0:6bf0743ece18 105 int WDT_Init(mxc_wdt_regs_t *wdt, const sys_cfg_wdt_t *cfg, uint8_t unlock_key);
demayer 0:6bf0743ece18 106
demayer 0:6bf0743ece18 107 /**
demayer 0:6bf0743ece18 108 * @brief Configures and enables the interrupt timeout for the watchdog specified.
demayer 0:6bf0743ece18 109 *
demayer 0:6bf0743ece18 110 * @param wdt Watchdog module to operate on
demayer 0:6bf0743ece18 111 * @param int_period Interrupt period as defined by wdt_period_t.
demayer 0:6bf0743ece18 112 * @param unlock_key Key to unlock watchdog. See #MXC_V_WDT_UNLOCK_KEY.
demayer 0:6bf0743ece18 113 *
demayer 0:6bf0743ece18 114 * @retval #E_NO_ERROR Interrupt enabled
demayer 0:6bf0743ece18 115 * @retval #E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
demayer 0:6bf0743ece18 116 */
demayer 0:6bf0743ece18 117 int WDT_EnableInt(mxc_wdt_regs_t *wdt, wdt_period_t int_period, uint8_t unlock_key);
demayer 0:6bf0743ece18 118
demayer 0:6bf0743ece18 119 /**
demayer 0:6bf0743ece18 120 * @brief Disables the interrupt timeout for the watchdog specified.
demayer 0:6bf0743ece18 121 *
demayer 0:6bf0743ece18 122 * @param wdt Pointer to the Watchdog Timer Instance
demayer 0:6bf0743ece18 123 * @param unlock_key Key to unlock watchdog. See #MXC_V_WDT_UNLOCK_KEY.
demayer 0:6bf0743ece18 124 *
demayer 0:6bf0743ece18 125 * @retval #E_NO_ERROR Interrupt disabled.
demayer 0:6bf0743ece18 126 * @retval #E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
demayer 0:6bf0743ece18 127 */
demayer 0:6bf0743ece18 128 int WDT_DisableInt(mxc_wdt_regs_t *wdt, uint8_t unlock_key);
demayer 0:6bf0743ece18 129
demayer 0:6bf0743ece18 130 /**
demayer 0:6bf0743ece18 131 * @brief Configures and enables the pre-window timeout for the watchdog specified.
demayer 0:6bf0743ece18 132 *
demayer 0:6bf0743ece18 133 * @param wdt Pointer to the Watchdog Timer Instance
demayer 0:6bf0743ece18 134 * @param wait_period Pre-window period, see wdt_period_t for accepted values.
demayer 0:6bf0743ece18 135 * @param unlock_key Key to unlock watchdog. See #MXC_V_WDT_UNLOCK_KEY.
demayer 0:6bf0743ece18 136 *
demayer 0:6bf0743ece18 137 * @retval #E_NO_ERROR Pre-window timeout set to wait_period
demayer 0:6bf0743ece18 138 * @retval #E_BAD_STATE WDT unable to be unlocked
demayer 0:6bf0743ece18 139 * @retval #E_INVALID Requested Period is greater than the maximum supported
demayer 0:6bf0743ece18 140 */
demayer 0:6bf0743ece18 141 int WDT_EnableWait(mxc_wdt_regs_t *wdt, wdt_period_t wait_period, uint8_t unlock_key);
demayer 0:6bf0743ece18 142
demayer 0:6bf0743ece18 143 /**
demayer 0:6bf0743ece18 144 * @brief Disables the pre-window timeout for the watchdog specified.
demayer 0:6bf0743ece18 145 *
demayer 0:6bf0743ece18 146 * @param wdt Pointer to the Watchdog Timer Instance
demayer 0:6bf0743ece18 147 * @param unlock_key Key to unlock watchdog. See #MXC_V_WDT_UNLOCK_KEY.
demayer 0:6bf0743ece18 148 *
demayer 0:6bf0743ece18 149 * @retval #E_NO_ERROR Wait disabled.
demayer 0:6bf0743ece18 150 * @retval #E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
demayer 0:6bf0743ece18 151 */
demayer 0:6bf0743ece18 152 int WDT_DisableWait(mxc_wdt_regs_t *wdt, uint8_t unlock_key);
demayer 0:6bf0743ece18 153
demayer 0:6bf0743ece18 154 /**
demayer 0:6bf0743ece18 155 * @brief Configures and enables the reset timeout for the watchdog specified.
demayer 0:6bf0743ece18 156 *
demayer 0:6bf0743ece18 157 * @param wdt Pointer to the Watchdog Timer Instance
demayer 0:6bf0743ece18 158 * @param rst_period Reset period, see wdt_period_t for accepted values.
demayer 0:6bf0743ece18 159 * @param unlock_key Key to unlock watchdog. See #MXC_V_WDT_UNLOCK_KEY.
demayer 0:6bf0743ece18 160 *
demayer 0:6bf0743ece18 161 * @retval #E_NO_ERROR Watchdog Timer Reset enabled with the rst_period time.
demayer 0:6bf0743ece18 162 * @retval #E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
demayer 0:6bf0743ece18 163 * @retval #E_INVALID Requested Period is greater than the maximum supported
demayer 0:6bf0743ece18 164 */
demayer 0:6bf0743ece18 165 int WDT_EnableReset(mxc_wdt_regs_t *wdt, wdt_period_t rst_period, uint8_t unlock_key);
demayer 0:6bf0743ece18 166
demayer 0:6bf0743ece18 167 /**
demayer 0:6bf0743ece18 168 * @brief Disables the reset timeout for the watchdog specified.
demayer 0:6bf0743ece18 169 *
demayer 0:6bf0743ece18 170 * @param wdt Pointer to the Watchdog Timer Instance
demayer 0:6bf0743ece18 171 * @param unlock_key Key to unlock watchdog. See #MXC_V_WDT_UNLOCK_KEY.
demayer 0:6bf0743ece18 172 *
demayer 0:6bf0743ece18 173 * @retval #E_NO_ERROR Reset disabled.
demayer 0:6bf0743ece18 174 * @retval #E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
demayer 0:6bf0743ece18 175 */
demayer 0:6bf0743ece18 176 int WDT_DisableReset(mxc_wdt_regs_t *wdt, uint8_t unlock_key);
demayer 0:6bf0743ece18 177
demayer 0:6bf0743ece18 178 /**
demayer 0:6bf0743ece18 179 * @brief Gets the watchdog interrupt flags
demayer 0:6bf0743ece18 180 *
demayer 0:6bf0743ece18 181 * @param wdt Pointer to the Watchdog Timer Instance.
demayer 0:6bf0743ece18 182 *
demayer 0:6bf0743ece18 183 * @retval uint32_t Value of the Watchdog Timer Flags.
demayer 0:6bf0743ece18 184 *
demayer 0:6bf0743ece18 185 */
demayer 0:6bf0743ece18 186 __STATIC_INLINE uint32_t WDT_GetFlags(mxc_wdt_regs_t *wdt)
demayer 0:6bf0743ece18 187 {
demayer 0:6bf0743ece18 188 return (wdt->flags);
demayer 0:6bf0743ece18 189 }
demayer 0:6bf0743ece18 190
demayer 0:6bf0743ece18 191 /**
demayer 0:6bf0743ece18 192 * @brief Clears the watchdog interrupt flags based on the mask
demayer 0:6bf0743ece18 193 *
demayer 0:6bf0743ece18 194 * @param wdt Pointer to the Watchdog Timer Instance
demayer 0:6bf0743ece18 195 * @param mask Watchdog Flags to clear
demayer 0:6bf0743ece18 196 *
demayer 0:6bf0743ece18 197 */
demayer 0:6bf0743ece18 198 __STATIC_INLINE void WDT_ClearFlags(mxc_wdt_regs_t *wdt, uint32_t mask)
demayer 0:6bf0743ece18 199 {
demayer 0:6bf0743ece18 200 wdt->flags = mask;
demayer 0:6bf0743ece18 201 }
demayer 0:6bf0743ece18 202
demayer 0:6bf0743ece18 203 /**
demayer 0:6bf0743ece18 204 * @brief Starts the specified Watchdog Timer instance.
demayer 0:6bf0743ece18 205 *
demayer 0:6bf0743ece18 206 * @param wdt Pointer to the Watchdog Timer instance
demayer 0:6bf0743ece18 207 * @param unlock_key Key to unlock watchdog.
demayer 0:6bf0743ece18 208 *
demayer 0:6bf0743ece18 209 * @retval #E_NO_ERROR Interrupt enabled.
demayer 0:6bf0743ece18 210 * @retval #E_BAD_STATE WDT1 Already Running
demayer 0:6bf0743ece18 211 * @retval #E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
demayer 0:6bf0743ece18 212 *
demayer 0:6bf0743ece18 213 */
demayer 0:6bf0743ece18 214 int WDT_Start(mxc_wdt_regs_t *wdt, uint8_t unlock_key);
demayer 0:6bf0743ece18 215
demayer 0:6bf0743ece18 216 /**
demayer 0:6bf0743ece18 217 * @brief Feeds the watchdog specified.
demayer 0:6bf0743ece18 218 *
demayer 0:6bf0743ece18 219 * @param wdt Watchdog module to operate on
demayer 0:6bf0743ece18 220 *
demayer 0:6bf0743ece18 221 */
demayer 0:6bf0743ece18 222 void WDT_Reset(mxc_wdt_regs_t *wdt);
demayer 0:6bf0743ece18 223
demayer 0:6bf0743ece18 224 /**
demayer 0:6bf0743ece18 225 * @brief Stops the watchdog specified.
demayer 0:6bf0743ece18 226 *
demayer 0:6bf0743ece18 227 * @param wdt Pointer to the Watchdog Timer Instance
demayer 0:6bf0743ece18 228 * @param unlock_key Key to unlock watchdog.
demayer 0:6bf0743ece18 229 *
demayer 0:6bf0743ece18 230 * @retval #E_NO_ERROR Interrupt enabled.
demayer 0:6bf0743ece18 231 * @retval #E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
demayer 0:6bf0743ece18 232 */
demayer 0:6bf0743ece18 233 int WDT_Stop(mxc_wdt_regs_t *wdt, uint8_t unlock_key);
demayer 0:6bf0743ece18 234
demayer 0:6bf0743ece18 235 /**
demayer 0:6bf0743ece18 236 * @brief Determines if the watchdog is running
demayer 0:6bf0743ece18 237 *
demayer 0:6bf0743ece18 238 * @param wdt Pointer to the Watchdog Timer Instance
demayer 0:6bf0743ece18 239 *
demayer 0:6bf0743ece18 240 * @retval 0 Watchdog timer is Disabled.
demayer 0:6bf0743ece18 241 * @retval non-zero Watchdog timer is Active
demayer 0:6bf0743ece18 242 */
demayer 0:6bf0743ece18 243 __STATIC_INLINE int WDT_IsActive(mxc_wdt_regs_t *wdt)
demayer 0:6bf0743ece18 244 {
demayer 0:6bf0743ece18 245 return (!!(wdt->ctrl & MXC_F_WDT_CTRL_EN_TIMER));
demayer 0:6bf0743ece18 246 }
demayer 0:6bf0743ece18 247
demayer 0:6bf0743ece18 248 /**@} end of group wdt*/
demayer 0:6bf0743ece18 249
demayer 0:6bf0743ece18 250 #ifdef __cplusplus
demayer 0:6bf0743ece18 251 }
demayer 0:6bf0743ece18 252 #endif
demayer 0:6bf0743ece18 253
demayer 0:6bf0743ece18 254 #endif /* _WDT_H */