lib/main/STM32H7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_ll_wwdg.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32h7xx_ll_wwdg.h
   4   * @author  MCD Application Team
   5   * @brief   Header file of WWDG LL module.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  10   * All rights reserved.</center></h2>
  11   *
  12   * This software component is licensed by ST under BSD 3-Clause license,
  13   * the "License"; You may not use this file except in compliance with the
  14   * License. You may obtain a copy of the License at:
  15   *                        opensource.org/licenses/BSD-3-Clause
  16   *
  17   ******************************************************************************
  18   */
  19
  20 /* Define to prevent recursive inclusion -------------------------------------*/
  21 #ifndef STM32H7xx_LL_WWDG_H
  22 #define STM32H7xx_LL_WWDG_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /* Includes ------------------------------------------------------------------*/
  29 #include "stm32h7xx.h"
  30
  31 /** @addtogroup STM32H7xx_LL_Driver
  32   * @{
  33   */
  34
  35 #if defined (WWDG1) || defined (WWDG2)
  36
  37 /** @defgroup WWDG_LL WWDG
  38   * @{
  39   */
  40
  41 /* Private types -------------------------------------------------------------*/
  42 /* Private variables ---------------------------------------------------------*/
  43 /* Private constants ---------------------------------------------------------*/
  44 /* Private macros ------------------------------------------------------------*/
  45 /* Exported types ------------------------------------------------------------*/
  46 /* Exported constants --------------------------------------------------------*/
  47 /** @defgroup WWDG_LL_Exported_Constants WWDG Exported Constants
  48   * @{
  49   */
  50
  51 /** @defgroup WWDG_LL_EC_IT IT Defines
  52   * @brief    IT defines which can be used with LL_WWDG_ReadReg and  LL_WWDG_WriteReg functions
  53   * @{
  54   */
  55 #define LL_WWDG_CFR_EWI                     WWDG_CFR_EWI
  56 /**
  57   * @}
  58   */
  59
  60 /** @defgroup WWDG_LL_EC_PRESCALER  PRESCALER
  61   * @{
  62   */
  63 #define LL_WWDG_PRESCALER_1                 0x00000000u                                               /*!< WWDG counter clock = (PCLK1/4096)/1 */
  64 #define LL_WWDG_PRESCALER_2                 WWDG_CFR_WDGTB_0                                          /*!< WWDG counter clock = (PCLK1/4096)/2 */
  65 #define LL_WWDG_PRESCALER_4                 WWDG_CFR_WDGTB_1                                          /*!< WWDG counter clock = (PCLK1/4096)/4 */
  66 #define LL_WWDG_PRESCALER_8                 (WWDG_CFR_WDGTB_0 | WWDG_CFR_WDGTB_1)                     /*!< WWDG counter clock = (PCLK1/4096)/8 */
  67 #define LL_WWDG_PRESCALER_16                WWDG_CFR_WDGTB_2                                          /*!< WWDG counter clock = (PCLK1/4096)/16 */
  68 #define LL_WWDG_PRESCALER_32                (WWDG_CFR_WDGTB_2 | WWDG_CFR_WDGTB_0)                     /*!< WWDG counter clock = (PCLK1/4096)/32 */
  69 #define LL_WWDG_PRESCALER_64                (WWDG_CFR_WDGTB_2 | WWDG_CFR_WDGTB_1)                     /*!< WWDG counter clock = (PCLK1/4096)/64 */
  70 #define LL_WWDG_PRESCALER_128               (WWDG_CFR_WDGTB_2 | WWDG_CFR_WDGTB_1 | WWDG_CFR_WDGTB_0)  /*!< WWDG counter clock = (PCLK1/4096)/128 */
  71 /**
  72   * @}
  73   */
  74
  75 /**
  76   * @}
  77   */
  78
  79 /* Exported macro ------------------------------------------------------------*/
  80 /** @defgroup WWDG_LL_Exported_Macros WWDG Exported Macros
  81   * @{
  82   */
  83 /** @defgroup WWDG_LL_EM_WRITE_READ Common Write and read registers macros
  84   * @{
  85   */
  86 /**
  87   * @brief  Write a value in WWDG register
  88   * @param  __INSTANCE__ WWDG Instance
  89   * @param  __REG__ Register to be written
  90   * @param  __VALUE__ Value to be written in the register
  91   * @retval None
  92   */
  93 #define LL_WWDG_WriteReg(__INSTANCE__, __REG__, __VALUE__) WRITE_REG(__INSTANCE__->__REG__, (__VALUE__))
  94
  95 /**
  96   * @brief  Read a value in WWDG register
  97   * @param  __INSTANCE__ WWDG Instance
  98   * @param  __REG__ Register to be read
  99   * @retval Register value
 100   */
 101 #define LL_WWDG_ReadReg(__INSTANCE__, __REG__) READ_REG(__INSTANCE__->__REG__)
 102 /**
 103   * @}
 104   */
 105
 106 /**
 107   * @}
 108   */
 109
 110 /* Exported functions --------------------------------------------------------*/
 111 /** @defgroup WWDG_LL_Exported_Functions WWDG Exported Functions
 112   * @{
 113   */
 114
 115 /** @defgroup WWDG_LL_EF_Configuration Configuration
 116   * @{
 117   */
 118 /**
 119   * @brief  Enable Window Watchdog. The watchdog is always disabled after a reset.
 120   * @note   It is enabled by setting the WDGA bit in the WWDG_CR register,
 121   *         then it cannot be disabled again except by a reset.
 122   *         This bit is set by software and only cleared by hardware after a reset.
 123   *         When WDGA = 1, the watchdog can generate a reset.
 124   * @rmtoll CR           WDGA          LL_WWDG_Enable
 125   * @param  WWDGx WWDG Instance
 126   * @retval None
 127   */
 128 __STATIC_INLINE void LL_WWDG_Enable(WWDG_TypeDef *WWDGx)
 129 {
 130   SET_BIT(WWDGx->CR, WWDG_CR_WDGA);
 131 }
 132
 133 /**
 134   * @brief  Checks if Window Watchdog is enabled
 135   * @rmtoll CR           WDGA          LL_WWDG_IsEnabled
 136   * @param  WWDGx WWDG Instance
 137   * @retval State of bit (1 or 0).
 138   */
 139 __STATIC_INLINE uint32_t LL_WWDG_IsEnabled(WWDG_TypeDef *WWDGx)
 140 {
 141   return ((READ_BIT(WWDGx->CR, WWDG_CR_WDGA) == (WWDG_CR_WDGA)) ? 1UL : 0UL);
 142 }
 143
 144 /**
 145   * @brief  Set the Watchdog counter value to provided value (7-bits T[6:0])
 146   * @note   When writing to the WWDG_CR register, always write 1 in the MSB b6 to avoid generating an immediate reset
 147   *         This counter is decremented every (4096 x 2expWDGTB) PCLK cycles
 148   *         A reset is produced when it rolls over from 0x40 to 0x3F (bit T6 becomes cleared)
 149   *         Setting the counter lower then 0x40 causes an immediate reset (if WWDG enabled)
 150   * @rmtoll CR           T             LL_WWDG_SetCounter
 151   * @param  WWDGx WWDG Instance
 152   * @param  Counter 0..0x7F (7 bit counter value)
 153   * @retval None
 154   */
 155 __STATIC_INLINE void LL_WWDG_SetCounter(WWDG_TypeDef *WWDGx, uint32_t Counter)
 156 {
 157   MODIFY_REG(WWDGx->CR, WWDG_CR_T, Counter);
 158 }
 159
 160 /**
 161   * @brief  Return current Watchdog Counter Value (7 bits counter value)
 162   * @rmtoll CR           T             LL_WWDG_GetCounter
 163   * @param  WWDGx WWDG Instance
 164   * @retval 7 bit Watchdog Counter value
 165   */
 166 __STATIC_INLINE uint32_t LL_WWDG_GetCounter(WWDG_TypeDef *WWDGx)
 167 {
 168   return (READ_BIT(WWDGx->CR, WWDG_CR_T));
 169 }
 170
 171 /**
 172   * @brief  Set the time base of the prescaler (WDGTB).
 173   * @note   Prescaler is used to apply ratio on PCLK clock, so that Watchdog counter
 174   *         is decremented every (4096 x 2expWDGTB) PCLK cycles
 175   * @rmtoll CFR          WDGTB         LL_WWDG_SetPrescaler
 176   * @param  WWDGx WWDG Instance
 177   * @param  Prescaler This parameter can be one of the following values:
 178   *         @arg @ref LL_WWDG_PRESCALER_1
 179   *         @arg @ref LL_WWDG_PRESCALER_2
 180   *         @arg @ref LL_WWDG_PRESCALER_4
 181   *         @arg @ref LL_WWDG_PRESCALER_8
 182   *         @arg @ref LL_WWDG_PRESCALER_16
 183   *         @arg @ref LL_WWDG_PRESCALER_32
 184   *         @arg @ref LL_WWDG_PRESCALER_64
 185   *         @arg @ref LL_WWDG_PRESCALER_128
 186   * @retval None
 187   */
 188 __STATIC_INLINE void LL_WWDG_SetPrescaler(WWDG_TypeDef *WWDGx, uint32_t Prescaler)
 189 {
 190   MODIFY_REG(WWDGx->CFR, WWDG_CFR_WDGTB, Prescaler);
 191 }
 192
 193 /**
 194   * @brief  Return current Watchdog Prescaler Value
 195   * @rmtoll CFR          WDGTB         LL_WWDG_GetPrescaler
 196   * @param  WWDGx WWDG Instance
 197   * @retval Returned value can be one of the following values:
 198   *         @arg @ref LL_WWDG_PRESCALER_1
 199   *         @arg @ref LL_WWDG_PRESCALER_2
 200   *         @arg @ref LL_WWDG_PRESCALER_4
 201   *         @arg @ref LL_WWDG_PRESCALER_8
 202   *         @arg @ref LL_WWDG_PRESCALER_16
 203   *         @arg @ref LL_WWDG_PRESCALER_32
 204   *         @arg @ref LL_WWDG_PRESCALER_64
 205   *         @arg @ref LL_WWDG_PRESCALER_128
 206   */
 207 __STATIC_INLINE uint32_t LL_WWDG_GetPrescaler(WWDG_TypeDef *WWDGx)
 208 {
 209   return (READ_BIT(WWDGx->CFR, WWDG_CFR_WDGTB));
 210 }
 211
 212 /**
 213   * @brief  Set the Watchdog Window value to be compared to the downcounter (7-bits W[6:0]).
 214   * @note   This window value defines when write in the WWDG_CR register
 215   *         to program Watchdog counter is allowed.
 216   *         Watchdog counter value update must occur only when the counter value
 217   *         is lower than the Watchdog window register value.
 218   *         Otherwise, a MCU reset is generated if the 7-bit Watchdog counter value
 219   *         (in the control register) is refreshed before the downcounter has reached
 220   *         the watchdog window register value.
 221   *         Physically is possible to set the Window lower then 0x40 but it is not recommended.
 222   *         To generate an immediate reset, it is possible to set the Counter lower than 0x40.
 223   * @rmtoll CFR          W             LL_WWDG_SetWindow
 224   * @param  WWDGx WWDG Instance
 225   * @param  Window 0x00..0x7F (7 bit Window value)
 226   * @retval None
 227   */
 228 __STATIC_INLINE void LL_WWDG_SetWindow(WWDG_TypeDef *WWDGx, uint32_t Window)
 229 {
 230   MODIFY_REG(WWDGx->CFR, WWDG_CFR_W, Window);
 231 }
 232
 233 /**
 234   * @brief  Return current Watchdog Window Value (7 bits value)
 235   * @rmtoll CFR          W             LL_WWDG_GetWindow
 236   * @param  WWDGx WWDG Instance
 237   * @retval 7 bit Watchdog Window value
 238   */
 239 __STATIC_INLINE uint32_t LL_WWDG_GetWindow(WWDG_TypeDef *WWDGx)
 240 {
 241   return (READ_BIT(WWDGx->CFR, WWDG_CFR_W));
 242 }
 243
 244 /**
 245   * @}
 246   */
 247
 248 /** @defgroup WWDG_LL_EF_FLAG_Management FLAG_Management
 249   * @{
 250   */
 251 /**
 252   * @brief  Indicates if the WWDG Early Wakeup Interrupt Flag is set or not.
 253   * @note   This bit is set by hardware when the counter has reached the value 0x40.
 254   *         It must be cleared by software by writing 0.
 255   *         A write of 1 has no effect. This bit is also set if the interrupt is not enabled.
 256   * @rmtoll SR           EWIF          LL_WWDG_IsActiveFlag_EWKUP
 257   * @param  WWDGx WWDG Instance
 258   * @retval State of bit (1 or 0).
 259   */
 260 __STATIC_INLINE uint32_t LL_WWDG_IsActiveFlag_EWKUP(WWDG_TypeDef *WWDGx)
 261 {
 262   return ((READ_BIT(WWDGx->SR, WWDG_SR_EWIF) == (WWDG_SR_EWIF)) ? 1UL : 0UL);
 263 }
 264
 265 /**
 266   * @brief  Clear WWDG Early Wakeup Interrupt Flag (EWIF)
 267   * @rmtoll SR           EWIF          LL_WWDG_ClearFlag_EWKUP
 268   * @param  WWDGx WWDG Instance
 269   * @retval None
 270   */
 271 __STATIC_INLINE void LL_WWDG_ClearFlag_EWKUP(WWDG_TypeDef *WWDGx)
 272 {
 273   WRITE_REG(WWDGx->SR, ~WWDG_SR_EWIF);
 274 }
 275
 276 /**
 277   * @}
 278   */
 279
 280 /** @defgroup WWDG_LL_EF_IT_Management IT_Management
 281   * @{
 282   */
 283 /**
 284   * @brief  Enable the Early Wakeup Interrupt.
 285   * @note   When set, an interrupt occurs whenever the counter reaches value 0x40.
 286   *         This interrupt is only cleared by hardware after a reset
 287   * @rmtoll CFR          EWI           LL_WWDG_EnableIT_EWKUP
 288   * @param  WWDGx WWDG Instance
 289   * @retval None
 290   */
 291 __STATIC_INLINE void LL_WWDG_EnableIT_EWKUP(WWDG_TypeDef *WWDGx)
 292 {
 293   SET_BIT(WWDGx->CFR, WWDG_CFR_EWI);
 294 }
 295
 296 /**
 297   * @brief  Check if Early Wakeup Interrupt is enabled
 298   * @rmtoll CFR          EWI           LL_WWDG_IsEnabledIT_EWKUP
 299   * @param  WWDGx WWDG Instance
 300   * @retval State of bit (1 or 0).
 301   */
 302 __STATIC_INLINE uint32_t LL_WWDG_IsEnabledIT_EWKUP(WWDG_TypeDef *WWDGx)
 303 {
 304   return ((READ_BIT(WWDGx->CFR, WWDG_CFR_EWI) == (WWDG_CFR_EWI)) ? 1UL : 0UL);
 305 }
 306
 307 /**
 308   * @}
 309   */
 310
 311 /**
 312   * @}
 313   */
 314
 315 /**
 316   * @}
 317   */
 318
 319 #endif /* WWDG1 || WWDG2 */
 320
 321 /**
 322   * @}
 323   */
 324
 325 #ifdef __cplusplus
 326 }
 327 #endif
 328
 329 #endif /* STM32H7xx_LL_WWDG_H */
 330
 331 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/