lib/main/STM32F7/Drivers/STM32F7xx_HAL_Driver/Inc/stm32f7xx_hal_wwdg.h

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