mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_STM/TARGET_STM32F0/device/stm32f0xx_hal_wwdg.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
180:96ed750bd169 
mbed library release version 165

Who changed what in which revision?

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