lib/main/STM32F3/Drivers/STM32F3xx_HAL_Driver/Inc/stm32f3xx_hal_wwdg.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f3xx_hal_wwdg.h
   4   * @author  MCD Application Team
   5   * @brief   Header file of WWDG HAL module.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
  10   *
  11   * Redistribution and use in source and binary forms, with or without modification,
  12   * are permitted provided that the following conditions are met:
  13   *   1. Redistributions of source code must retain the above copyright notice,
  14   *      this list of conditions and the following disclaimer.
  15   *   2. Redistributions in binary form must reproduce the above copyright notice,
  16   *      this list of conditions and the following disclaimer in the documentation
  17   *      and/or other materials provided with the distribution.
  18   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  19   *      may be used to endorse or promote products derived from this software
  20   *      without specific prior written permission.
  21   *
  22   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  26   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32   *
  33   ******************************************************************************
  34   */
  35
  36 /* Define to prevent recursive inclusion -------------------------------------*/
  37 #ifndef __STM32F3xx_HAL_WWDG_H
  38 #define __STM32F3xx_HAL_WWDG_H
  39
  40 #ifdef __cplusplus
  41  extern "C" {
  42 #endif
  43
  44 /* Includes ------------------------------------------------------------------*/
  45 #include "stm32f3xx_hal_def.h"
  46
  47 /** @addtogroup STM32F3xx_HAL_Driver
  48   * @{
  49   */
  50
  51 /** @addtogroup WWDG
  52   * @{
  53   */
  54
  55 /* Exported types ------------------------------------------------------------*/
  56
  57 /** @defgroup WWDG_Exported_Types WWDG Exported Types
  58   * @{
  59   */
  60
  61 /**
  62   * @brief  WWDG Init structure definition
  63   */
  64 typedef struct
  65 {
  66   uint32_t Prescaler;     /*!< Specifies the prescaler value of the WWDG.
  67                                This parameter can be a value of @ref WWDG_Prescaler */
  68
  69   uint32_t Window;        /*!< Specifies the WWDG window value to be compared to the downcounter.
  70                                This parameter must be a number Min_Data = 0x40 and Max_Data = 0x7FU */
  71
  72   uint32_t Counter;       /*!< Specifies the WWDG free-running downcounter  value.
  73                                This parameter must be a number between Min_Data = 0x40 and Max_Data = 0x7FU */
  74
  75   uint32_t EWIMode ;      /*!< Specifies if WWDG Early Wakeup Interupt is enable or not.
  76                                This parameter can be a value of @ref WWDG_EWI_Mode */
  77
  78 }WWDG_InitTypeDef;
  79
  80 /**
  81   * @brief  WWDG handle Structure definition
  82   */
  83 typedef struct
  84 {
  85   WWDG_TypeDef                 *Instance;  /*!< Register base address    */
  86
  87   WWDG_InitTypeDef             Init;       /*!< WWDG required parameters */
  88
  89 }WWDG_HandleTypeDef;
  90 /**
  91   * @}
  92   */
  93
  94 /* Exported constants --------------------------------------------------------*/
  95
  96 /** @defgroup WWDG_Exported_Constants WWDG Exported Constants
  97   * @{
  98   */
  99
 100 /** @defgroup WWDG_Interrupt_definition WWDG Interrupt definition
 101   * @{
 102   */
 103 #define WWDG_IT_EWI                         WWDG_CFR_EWI  /*!< Early wakeup interrupt */
 104 /**
 105   * @}
 106   */
 107
 108 /** @defgroup WWDG_Flag_definition WWDG Flag definition
 109   * @brief WWDG Flag definition
 110   * @{
 111   */
 112 #define WWDG_FLAG_EWIF                      WWDG_SR_EWIF  /*!< Early wakeup interrupt flag */
 113 /**
 114   * @}
 115   */
 116
 117 /** @defgroup WWDG_Prescaler WWDG Prescaler
 118   * @{
 119   */
 120 #define WWDG_PRESCALER_1                    0x00000000u       /*!< WWDG counter clock = (PCLK1/4096U)/1U */
 121 #define WWDG_PRESCALER_2                    WWDG_CFR_WDGTB_0  /*!< WWDG counter clock = (PCLK1/4096U)/2U */
 122 #define WWDG_PRESCALER_4                    WWDG_CFR_WDGTB_1  /*!< WWDG counter clock = (PCLK1/4096U)/4U */
 123 #define WWDG_PRESCALER_8                    WWDG_CFR_WDGTB    /*!< WWDG counter clock = (PCLK1/4096U)/8U */
 124 /**
 125   * @}
 126   */
 127
 128 /** @defgroup WWDG_EWI_Mode WWDG Early Wakeup Interrupt Mode
 129   * @{
 130   */
 131 #define WWDG_EWI_DISABLE                    0x00000000u       /*!< EWI Disable */
 132 #define WWDG_EWI_ENABLE                     WWDG_CFR_EWI      /*!< EWI Enable */
 133 /**
 134   * @}
 135   */
 136
 137 /**
 138   * @}
 139   */
 140
 141 /* Private macros ------------------------------------------------------------*/
 142
 143 /** @defgroup WWDG_Private_Macros WWDG Private Macros
 144   * @{
 145   */
 146 #define IS_WWDG_PRESCALER(__PRESCALER__)    (((__PRESCALER__) == WWDG_PRESCALER_1) || \
 147                                              ((__PRESCALER__) == WWDG_PRESCALER_2) || \
 148                                              ((__PRESCALER__) == WWDG_PRESCALER_4) || \
 149                                              ((__PRESCALER__) == WWDG_PRESCALER_8))
 150
 151 #define IS_WWDG_WINDOW(__WINDOW__)          (((__WINDOW__) >= WWDG_CFR_W_6) && ((__WINDOW__) <= WWDG_CFR_W))
 152
 153 #define IS_WWDG_COUNTER(__COUNTER__)        (((__COUNTER__) >= WWDG_CR_T_6) && ((__COUNTER__) <= WWDG_CR_T))
 154
 155 #define IS_WWDG_EWI_MODE(__MODE__)          (((__MODE__) == WWDG_EWI_ENABLE) || \
 156                                              ((__MODE__) == WWDG_EWI_DISABLE))
 157 /**
 158   * @}
 159   */
 160
 161
 162 /* Exported macros ------------------------------------------------------------*/
 163
 164 /** @defgroup WWDG_Exported_Macros WWDG Exported Macros
 165   * @{
 166   */
 167
 168 /**
 169   * @brief  Enable the WWDG peripheral.
 170   * @param  __HANDLE__  WWDG handle
 171   * @retval None
 172   */
 173 #define __HAL_WWDG_ENABLE(__HANDLE__)                         SET_BIT((__HANDLE__)->Instance->CR, WWDG_CR_WDGA)
 174
 175 /**
 176   * @brief  Enable the WWDG early wakeup interrupt.
 177   * @param  __HANDLE__ WWDG handle
 178   * @param  __INTERRUPT__  specifies the interrupt to enable.
 179   *         This parameter can be one of the following values:
 180   *            @arg WWDG_IT_EWI: Early wakeup interrupt
 181   * @note   Once enabled this interrupt cannot be disabled except by a system reset.
 182   * @retval None
 183   */
 184 #define __HAL_WWDG_ENABLE_IT(__HANDLE__, __INTERRUPT__)       SET_BIT((__HANDLE__)->Instance->CFR, (__INTERRUPT__))
 185
 186 /**
 187   * @brief  Check whether the selected WWDG interrupt has occurred or not.
 188   * @param  __HANDLE__  WWDG handle
 189   * @param  __INTERRUPT__  specifies the it to check.
 190   *        This parameter can be one of the following values:
 191   *            @arg WWDG_FLAG_EWIF: Early wakeup interrupt IT
 192   * @retval The new state of WWDG_FLAG (SET or RESET).
 193   */
 194 #define __HAL_WWDG_GET_IT(__HANDLE__, __INTERRUPT__)        __HAL_WWDG_GET_FLAG((__HANDLE__),(__INTERRUPT__))
 195
 196 /** @brief  Clear the WWDG interrupt pending bits.
 197   *         bits to clear the selected interrupt pending bits.
 198   * @param  __HANDLE__  WWDG handle
 199   * @param  __INTERRUPT__  specifies the interrupt pending bit to clear.
 200   *         This parameter can be one of the following values:
 201   *            @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
 202   */
 203 #define __HAL_WWDG_CLEAR_IT(__HANDLE__, __INTERRUPT__)      __HAL_WWDG_CLEAR_FLAG((__HANDLE__), (__INTERRUPT__))
 204
 205 /**
 206   * @brief  Check whether the specified WWDG flag is set or not.
 207   * @param  __HANDLE__  WWDG handle
 208   * @param  __FLAG__  specifies the flag to check.
 209   *         This parameter can be one of the following values:
 210   *            @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
 211   * @retval The new state of WWDG_FLAG (SET or RESET).
 212   */
 213 #define __HAL_WWDG_GET_FLAG(__HANDLE__, __FLAG__)           (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
 214
 215 /**
 216   * @brief  Clear the WWDG's pending flags.
 217   * @param  __HANDLE__  WWDG handle
 218   * @param  __FLAG__  specifies the flag to clear.
 219   *         This parameter can be one of the following values:
 220   *            @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
 221   * @retval None
 222   */
 223 #define __HAL_WWDG_CLEAR_FLAG(__HANDLE__, __FLAG__)         ((__HANDLE__)->Instance->SR = ~(__FLAG__))
 224
 225 /** @brief  Check whether the specified WWDG interrupt source is enabled or not.
 226   * @param  __HANDLE__  WWDG Handle.
 227   * @param  __INTERRUPT__  specifies the WWDG interrupt source to check.
 228   *         This parameter can be one of the following values:
 229   *            @arg WWDG_IT_EWI: Early Wakeup Interrupt
 230   * @retval state of __INTERRUPT__ (TRUE or FALSE).
 231   */
 232 #define __HAL_WWDG_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CFR & (__INTERRUPT__)) == (__INTERRUPT__))
 233
 234 /**
 235   * @}
 236   */
 237
 238 /* Exported functions --------------------------------------------------------*/
 239
 240 /** @addtogroup WWDG_Exported_Functions
 241   * @{
 242   */
 243
 244 /** @addtogroup WWDG_Exported_Functions_Group1
 245   * @{
 246   */
 247 /* Initialization/de-initialization functions  **********************************/
 248 HAL_StatusTypeDef     HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg);
 249 void                  HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg);
 250 /**
 251   * @}
 252   */
 253
 254 /** @addtogroup WWDG_Exported_Functions_Group2
 255   * @{
 256   */
 257 /* I/O operation functions ******************************************************/
 258 HAL_StatusTypeDef     HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg);
 259 void                  HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg);
 260 void                  HAL_WWDG_EarlyWakeupCallback(WWDG_HandleTypeDef* hwwdg);
 261 /**
 262   * @}
 263   */
 264
 265 /**
 266   * @}
 267   */
 268
 269 /**
 270   * @}
 271   */
 272
 273 /**
 274   * @}
 275   */
 276
 277 #ifdef __cplusplus
 278 }
 279 #endif
 280
 281 #endif /* __STM32F3xx_HAL_WWDG_H */
 282
 283 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/