Gan likun / mbed1-dev

001

targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_wwdg.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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