TUKS MCU Introductory course / TUKS-COURSE-2-LED

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

HAL_L476/stm32l4xx_hal_wwdg.h@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

Who changed what in which revision?

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