Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_wwdg.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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