mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_L4R5ZI_P/TOOLCHAIN_ARM_STD/stm32l4xx_hal_wwdg.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
mbed library release version 165

Who changed what in which revision?

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