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_DISCO_L475VG_IOT01A/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_wwdg.h@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Child:
161:aa5281ff4a02
Release 145 of the mbed library.

Who changed what in which revision?

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