mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_iwdg.c@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /**
<> 144:ef7eb2e8f9f7 2 ******************************************************************************
<> 144:ef7eb2e8f9f7 3 * @file stm32l0xx_hal_iwdg.c
<> 144:ef7eb2e8f9f7 4 * @author MCD Application Team
<> 144:ef7eb2e8f9f7 5 * @brief IWDG HAL module driver.
<> 144:ef7eb2e8f9f7 6 * This file provides firmware functions to manage the following
<> 144:ef7eb2e8f9f7 7 * functionalities of the Independent Watchdog (IWDG) peripheral:
Anna Bridge 186:707f6e361f3e 8 * + Initialization and Start functions
<> 144:ef7eb2e8f9f7 9 * + IO operation functions
Anna Bridge 186:707f6e361f3e 10 *
<> 144:ef7eb2e8f9f7 11 @verbatim
<> 144:ef7eb2e8f9f7 12 ==============================================================================
<> 144:ef7eb2e8f9f7 13 ##### IWDG Generic features #####
<> 144:ef7eb2e8f9f7 14 ==============================================================================
Anna Bridge 186:707f6e361f3e 15 [..]
<> 144:ef7eb2e8f9f7 16 (+) The IWDG can be started by either software or hardware (configurable
Anna Bridge 186:707f6e361f3e 17 through option byte).
Anna Bridge 186:707f6e361f3e 18
Anna Bridge 186:707f6e361f3e 19 (+) The IWDG is clocked by Low-Speed clock (LSI) and thus stays active even
Anna Bridge 186:707f6e361f3e 20 if the main clock fails.
<> 144:ef7eb2e8f9f7 21
Anna Bridge 186:707f6e361f3e 22 (+) Once the IWDG is started, the LSI is forced ON and both can not be
Anna Bridge 186:707f6e361f3e 23 disabled. The counter starts counting down from the reset value (0xFFF).
Anna Bridge 186:707f6e361f3e 24 When it reaches the end of count value (0x000) a reset signal is
Anna Bridge 186:707f6e361f3e 25 generated (IWDG reset).
<> 144:ef7eb2e8f9f7 26
Anna Bridge 186:707f6e361f3e 27 (+) Whenever the key value 0x0000 AAAA is written in the IWDG_KR register,
Anna Bridge 186:707f6e361f3e 28 the IWDG_RLR value is reloaded in the counter and the watchdog reset is
Anna Bridge 186:707f6e361f3e 29 prevented.
<> 144:ef7eb2e8f9f7 30
<> 144:ef7eb2e8f9f7 31 (+) The IWDG is implemented in the VDD voltage domain that is still functional
Anna Bridge 186:707f6e361f3e 32 in STOP and STANDBY mode (IWDG reset can wake-up from STANDBY).
Anna Bridge 186:707f6e361f3e 33 IWDGRST flag in RCC_CSR register can be used to inform when an IWDG
Anna Bridge 186:707f6e361f3e 34 reset occurs.
Anna Bridge 186:707f6e361f3e 35
Anna Bridge 186:707f6e361f3e 36 (+) Debug mode : When the microcontroller enters debug mode (core halted),
Anna Bridge 186:707f6e361f3e 37 the IWDG counter either continues to work normally or stops, depending
Anna Bridge 186:707f6e361f3e 38 on DBG_IWDG_STOP configuration bit in DBG module, accessible through
Anna Bridge 186:707f6e361f3e 39 __HAL_DBGMCU_FREEZE_IWDG() and __HAL_DBGMCU_UNFREEZE_IWDG() macros
<> 144:ef7eb2e8f9f7 40
<> 144:ef7eb2e8f9f7 41 [..] Min-max timeout value @32KHz (LSI): ~0.512ms / ~32.0s
<> 144:ef7eb2e8f9f7 42 The IWDG timeout may vary due to LSI frequency dispersion. STM32L0xx
<> 144:ef7eb2e8f9f7 43 devices provide the capability to measure the LSI frequency (LSI clock
<> 144:ef7eb2e8f9f7 44 connected internally to TIM5 CH4 input capture). The measured value
<> 144:ef7eb2e8f9f7 45 can be used to have an IWDG timeout with an acceptable accuracy.
<> 144:ef7eb2e8f9f7 46
<> 144:ef7eb2e8f9f7 47 ##### How to use this driver #####
<> 144:ef7eb2e8f9f7 48 ==============================================================================
Anna Bridge 186:707f6e361f3e 49 [..]
Anna Bridge 186:707f6e361f3e 50 (#) Use IWDG using HAL_IWDG_Init() function to :
Anna Bridge 186:707f6e361f3e 51 (++) Enable instance by writing Start keyword in IWDG_KEY register. LSI
Anna Bridge 186:707f6e361f3e 52 clock is forced ON and IWDG counter starts downcounting.
Anna Bridge 186:707f6e361f3e 53 (++) Enable write access to configuration register: IWDG_PR, IWDG_RLR &
Anna Bridge 186:707f6e361f3e 54 IWDG_WINR.
Anna Bridge 186:707f6e361f3e 55 (++) Configure the IWDG prescaler and counter reload value. This reload
Anna Bridge 186:707f6e361f3e 56 value will be loaded in the IWDG counter each time the watchdog is
Anna Bridge 186:707f6e361f3e 57 reloaded, then the IWDG will start counting down from this value.
Anna Bridge 186:707f6e361f3e 58 (++) Wait for status flags to be reset
Anna Bridge 186:707f6e361f3e 59 (++) Depending on window parameter:
Anna Bridge 186:707f6e361f3e 60 (+++) If Window Init parameter is same as Window register value,
Anna Bridge 186:707f6e361f3e 61 nothing more is done but reload counter value in order to exit
Anna Bridge 186:707f6e361f3e 62 function withy exact time base.
Anna Bridge 186:707f6e361f3e 63 (+++) Else modify Window register. This will automatically reload
Anna Bridge 186:707f6e361f3e 64 watchdog counter.
Anna Bridge 186:707f6e361f3e 65
Anna Bridge 186:707f6e361f3e 66 (#) Then the application program must refresh the IWDG counter at regular
Anna Bridge 186:707f6e361f3e 67 intervals during normal operation to prevent an MCU reset, using
Anna Bridge 186:707f6e361f3e 68 HAL_IWDG_Refresh() function.
<> 144:ef7eb2e8f9f7 69
<> 144:ef7eb2e8f9f7 70 *** IWDG HAL driver macros list ***
<> 144:ef7eb2e8f9f7 71 ====================================
<> 144:ef7eb2e8f9f7 72 [..]
Anna Bridge 186:707f6e361f3e 73 Below the list of most used macros in IWDG HAL driver:
<> 144:ef7eb2e8f9f7 74 (+) __HAL_IWDG_START: Enable the IWDG peripheral
Anna Bridge 186:707f6e361f3e 75 (+) __HAL_IWDG_RELOAD_COUNTER: Reloads IWDG counter with value defined in
Anna Bridge 186:707f6e361f3e 76 the reload register
Anna Bridge 186:707f6e361f3e 77
<> 144:ef7eb2e8f9f7 78 @endverbatim
<> 144:ef7eb2e8f9f7 79 ******************************************************************************
<> 144:ef7eb2e8f9f7 80 * @attention
<> 144:ef7eb2e8f9f7 81 *
<> 144:ef7eb2e8f9f7 82 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
<> 144:ef7eb2e8f9f7 83 *
<> 144:ef7eb2e8f9f7 84 * Redistribution and use in source and binary forms, with or without modification,
<> 144:ef7eb2e8f9f7 85 * are permitted provided that the following conditions are met:
<> 144:ef7eb2e8f9f7 86 * 1. Redistributions of source code must retain the above copyright notice,
<> 144:ef7eb2e8f9f7 87 * this list of conditions and the following disclaimer.
<> 144:ef7eb2e8f9f7 88 * 2. Redistributions in binary form must reproduce the above copyright notice,
<> 144:ef7eb2e8f9f7 89 * this list of conditions and the following disclaimer in the documentation
<> 144:ef7eb2e8f9f7 90 * and/or other materials provided with the distribution.
<> 144:ef7eb2e8f9f7 91 * 3. Neither the name of STMicroelectronics nor the names of its contributors
<> 144:ef7eb2e8f9f7 92 * may be used to endorse or promote products derived from this software
<> 144:ef7eb2e8f9f7 93 * without specific prior written permission.
<> 144:ef7eb2e8f9f7 94 *
<> 144:ef7eb2e8f9f7 95 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
<> 144:ef7eb2e8f9f7 96 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
<> 144:ef7eb2e8f9f7 97 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 144:ef7eb2e8f9f7 98 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
<> 144:ef7eb2e8f9f7 99 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
<> 144:ef7eb2e8f9f7 100 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
<> 144:ef7eb2e8f9f7 101 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
<> 144:ef7eb2e8f9f7 102 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
<> 144:ef7eb2e8f9f7 103 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
<> 144:ef7eb2e8f9f7 104 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 144:ef7eb2e8f9f7 105 *
<> 144:ef7eb2e8f9f7 106 ******************************************************************************
<> 144:ef7eb2e8f9f7 107 */
<> 144:ef7eb2e8f9f7 108
<> 144:ef7eb2e8f9f7 109 /* Includes ------------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 110 #include "stm32l0xx_hal.h"
<> 144:ef7eb2e8f9f7 111
<> 144:ef7eb2e8f9f7 112 /** @addtogroup STM32L0xx_HAL_Driver
<> 144:ef7eb2e8f9f7 113 * @{
<> 144:ef7eb2e8f9f7 114 */
<> 144:ef7eb2e8f9f7 115
<> 144:ef7eb2e8f9f7 116 #ifdef HAL_IWDG_MODULE_ENABLED
<> 144:ef7eb2e8f9f7 117 /** @addtogroup IWDG
<> 144:ef7eb2e8f9f7 118 * @brief IWDG HAL module driver.
<> 144:ef7eb2e8f9f7 119 * @{
<> 144:ef7eb2e8f9f7 120 */
<> 144:ef7eb2e8f9f7 121
Anna Bridge 186:707f6e361f3e 122 /* Private typedef -----------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 123 /* Private define ------------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 124 /** @defgroup IWDG_Private_Defines IWDG Private Defines
<> 144:ef7eb2e8f9f7 125 * @{
<> 144:ef7eb2e8f9f7 126 */
Anna Bridge 186:707f6e361f3e 127 /* Status register need 5 RC LSI divided by prescaler clock to be updated. With
Anna Bridge 186:707f6e361f3e 128 higher prescaler (256), and according to LSI variation, we need to wait at
Anna Bridge 186:707f6e361f3e 129 least 6 cycles so 48 ms. */
Anna Bridge 186:707f6e361f3e 130 #define HAL_IWDG_DEFAULT_TIMEOUT 48U
<> 144:ef7eb2e8f9f7 131 /**
<> 144:ef7eb2e8f9f7 132 * @}
<> 144:ef7eb2e8f9f7 133 */
<> 144:ef7eb2e8f9f7 134
Anna Bridge 186:707f6e361f3e 135 /* Private macro -------------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 136 /* Private variables ---------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 137 /* Private function prototypes -----------------------------------------------*/
Anna Bridge 186:707f6e361f3e 138 /* Exported functions --------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 139
<> 144:ef7eb2e8f9f7 140 /** @addtogroup IWDG_Exported_Functions
<> 144:ef7eb2e8f9f7 141 * @{
<> 144:ef7eb2e8f9f7 142 */
<> 144:ef7eb2e8f9f7 143
<> 144:ef7eb2e8f9f7 144 /** @addtogroup IWDG_Exported_Functions_Group1
Anna Bridge 186:707f6e361f3e 145 * @brief Initialization and Start functions.
<> 144:ef7eb2e8f9f7 146 *
<> 144:ef7eb2e8f9f7 147 @verbatim
<> 144:ef7eb2e8f9f7 148 ===============================================================================
Anna Bridge 186:707f6e361f3e 149 ##### Initialization and Start functions #####
<> 144:ef7eb2e8f9f7 150 ===============================================================================
Anna Bridge 186:707f6e361f3e 151 [..] This section provides functions allowing to:
Anna Bridge 186:707f6e361f3e 152 (+) Initialize the IWDG according to the specified parameters in the
Anna Bridge 186:707f6e361f3e 153 IWDG_InitTypeDef of associated handle.
Anna Bridge 186:707f6e361f3e 154 (+) Manage Window option.
Anna Bridge 186:707f6e361f3e 155 (+) Once initialization is performed in HAL_IWDG_Init function, Watchdog
Anna Bridge 186:707f6e361f3e 156 is reloaded in order to exit function with correct time base.
<> 144:ef7eb2e8f9f7 157
<> 144:ef7eb2e8f9f7 158 @endverbatim
<> 144:ef7eb2e8f9f7 159 * @{
<> 144:ef7eb2e8f9f7 160 */
<> 144:ef7eb2e8f9f7 161
<> 144:ef7eb2e8f9f7 162 /**
Anna Bridge 186:707f6e361f3e 163 * @brief Initialize the IWDG according to the specified parameters in the
Anna Bridge 186:707f6e361f3e 164 * IWDG_InitTypeDef and start watchdog. Before exiting function,
Anna Bridge 186:707f6e361f3e 165 * watchdog is refreshed in order to have correct time base.
Anna Bridge 186:707f6e361f3e 166 * @param hiwdg pointer to a IWDG_HandleTypeDef structure that contains
Anna Bridge 186:707f6e361f3e 167 * the configuration information for the specified IWDG module.
<> 144:ef7eb2e8f9f7 168 * @retval HAL status
<> 144:ef7eb2e8f9f7 169 */
<> 144:ef7eb2e8f9f7 170 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg)
<> 144:ef7eb2e8f9f7 171 {
Anna Bridge 186:707f6e361f3e 172 uint32_t tickstart;
<> 144:ef7eb2e8f9f7 173
<> 144:ef7eb2e8f9f7 174 /* Check the IWDG handle allocation */
<> 144:ef7eb2e8f9f7 175 if(hiwdg == NULL)
<> 144:ef7eb2e8f9f7 176 {
<> 144:ef7eb2e8f9f7 177 return HAL_ERROR;
<> 144:ef7eb2e8f9f7 178 }
<> 144:ef7eb2e8f9f7 179
<> 144:ef7eb2e8f9f7 180 /* Check the parameters */
Anna Bridge 186:707f6e361f3e 181 assert_param(IS_IWDG_ALL_INSTANCE(hiwdg->Instance));
<> 144:ef7eb2e8f9f7 182 assert_param(IS_IWDG_PRESCALER(hiwdg->Init.Prescaler));
<> 144:ef7eb2e8f9f7 183 assert_param(IS_IWDG_RELOAD(hiwdg->Init.Reload));
<> 144:ef7eb2e8f9f7 184 assert_param(IS_IWDG_WINDOW(hiwdg->Init.Window));
<> 144:ef7eb2e8f9f7 185
Anna Bridge 186:707f6e361f3e 186 /* Enable IWDG. LSI is turned on automaticaly */
Anna Bridge 186:707f6e361f3e 187 __HAL_IWDG_START(hiwdg);
<> 144:ef7eb2e8f9f7 188
Anna Bridge 186:707f6e361f3e 189 /* Enable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers by writing
Anna Bridge 186:707f6e361f3e 190 0x5555 in KR */
<> 144:ef7eb2e8f9f7 191 IWDG_ENABLE_WRITE_ACCESS(hiwdg);
<> 144:ef7eb2e8f9f7 192
Anna Bridge 186:707f6e361f3e 193 /* Write to IWDG registers the Prescaler & Reload values to work with */
Anna Bridge 186:707f6e361f3e 194 hiwdg->Instance->PR = hiwdg->Init.Prescaler;
Anna Bridge 186:707f6e361f3e 195 hiwdg->Instance->RLR = hiwdg->Init.Reload;
<> 144:ef7eb2e8f9f7 196
Anna Bridge 186:707f6e361f3e 197 /* Check pending flag, if previous update not done, return timeout */
<> 144:ef7eb2e8f9f7 198 tickstart = HAL_GetTick();
<> 144:ef7eb2e8f9f7 199
Anna Bridge 186:707f6e361f3e 200 /* Wait for register to be updated */
Anna Bridge 186:707f6e361f3e 201 while(hiwdg->Instance->SR != RESET)
<> 144:ef7eb2e8f9f7 202 {
Anna Bridge 186:707f6e361f3e 203 if((HAL_GetTick() - tickstart ) > HAL_IWDG_DEFAULT_TIMEOUT)
Anna Bridge 186:707f6e361f3e 204 {
<> 144:ef7eb2e8f9f7 205 return HAL_TIMEOUT;
<> 144:ef7eb2e8f9f7 206 }
<> 144:ef7eb2e8f9f7 207 }
<> 144:ef7eb2e8f9f7 208
Anna Bridge 186:707f6e361f3e 209 /* If window parameter is different than current value, modify window
Anna Bridge 186:707f6e361f3e 210 register */
Anna Bridge 186:707f6e361f3e 211 if(hiwdg->Instance->WINR != hiwdg->Init.Window)
Anna Bridge 186:707f6e361f3e 212 {
Anna Bridge 186:707f6e361f3e 213 /* Write to IWDG WINR the IWDG_Window value to compare with. In any case,
Anna Bridge 186:707f6e361f3e 214 even if window feature is disabled, Watchdog will be reloaded by writing
Anna Bridge 186:707f6e361f3e 215 windows register */
Anna Bridge 186:707f6e361f3e 216 hiwdg->Instance->WINR = hiwdg->Init.Window;
Anna Bridge 186:707f6e361f3e 217 }
Anna Bridge 186:707f6e361f3e 218 else
Anna Bridge 186:707f6e361f3e 219 {
Anna Bridge 186:707f6e361f3e 220 /* Reload IWDG counter with value defined in the reload register */
Anna Bridge 186:707f6e361f3e 221 __HAL_IWDG_RELOAD_COUNTER(hiwdg);
Anna Bridge 186:707f6e361f3e 222 }
<> 144:ef7eb2e8f9f7 223
<> 144:ef7eb2e8f9f7 224 /* Return function status */
<> 144:ef7eb2e8f9f7 225 return HAL_OK;
<> 144:ef7eb2e8f9f7 226 }
<> 144:ef7eb2e8f9f7 227
<> 144:ef7eb2e8f9f7 228 /**
<> 144:ef7eb2e8f9f7 229 * @}
<> 144:ef7eb2e8f9f7 230 */
<> 144:ef7eb2e8f9f7 231
Anna Bridge 186:707f6e361f3e 232
Anna Bridge 186:707f6e361f3e 233 /** @addtogroup IWDG_Exported_Functions_Group2
Anna Bridge 186:707f6e361f3e 234 * @brief IO operation functions
<> 144:ef7eb2e8f9f7 235 *
<> 144:ef7eb2e8f9f7 236 @verbatim
<> 144:ef7eb2e8f9f7 237 ===============================================================================
Anna Bridge 186:707f6e361f3e 238 ##### IO operation functions #####
<> 144:ef7eb2e8f9f7 239 ===============================================================================
Anna Bridge 186:707f6e361f3e 240 [..] This section provides functions allowing to:
Anna Bridge 186:707f6e361f3e 241 (+) Refresh the IWDG.
<> 144:ef7eb2e8f9f7 242
<> 144:ef7eb2e8f9f7 243 @endverbatim
<> 144:ef7eb2e8f9f7 244 * @{
<> 144:ef7eb2e8f9f7 245 */
<> 144:ef7eb2e8f9f7 246
Anna Bridge 186:707f6e361f3e 247
<> 144:ef7eb2e8f9f7 248 /**
Anna Bridge 186:707f6e361f3e 249 * @brief Refresh the IWDG.
Anna Bridge 186:707f6e361f3e 250 * @param hiwdg pointer to a IWDG_HandleTypeDef structure that contains
Anna Bridge 186:707f6e361f3e 251 * the configuration information for the specified IWDG module.
Anna Bridge 186:707f6e361f3e 252 * @retval HAL status
<> 144:ef7eb2e8f9f7 253 */
Anna Bridge 186:707f6e361f3e 254 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg)
<> 144:ef7eb2e8f9f7 255 {
Anna Bridge 186:707f6e361f3e 256 /* Reload IWDG counter with value defined in the reload register */
Anna Bridge 186:707f6e361f3e 257 __HAL_IWDG_RELOAD_COUNTER(hiwdg);
Anna Bridge 186:707f6e361f3e 258
Anna Bridge 186:707f6e361f3e 259 /* Return function status */
Anna Bridge 186:707f6e361f3e 260 return HAL_OK;
<> 144:ef7eb2e8f9f7 261 }
<> 144:ef7eb2e8f9f7 262
<> 144:ef7eb2e8f9f7 263 /**
<> 144:ef7eb2e8f9f7 264 * @}
<> 144:ef7eb2e8f9f7 265 */
<> 144:ef7eb2e8f9f7 266
<> 144:ef7eb2e8f9f7 267 /**
<> 144:ef7eb2e8f9f7 268 * @}
<> 144:ef7eb2e8f9f7 269 */
<> 144:ef7eb2e8f9f7 270
Anna Bridge 186:707f6e361f3e 271 #endif /* HAL_IWDG_MODULE_ENABLED */
<> 144:ef7eb2e8f9f7 272 /**
<> 144:ef7eb2e8f9f7 273 * @}
<> 144:ef7eb2e8f9f7 274 */
<> 144:ef7eb2e8f9f7 275
<> 144:ef7eb2e8f9f7 276 /**
<> 144:ef7eb2e8f9f7 277 * @}
<> 144:ef7eb2e8f9f7 278 */
<> 144:ef7eb2e8f9f7 279
<> 144:ef7eb2e8f9f7 280 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/