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_STM32L1/device/stm32l1xx_hal_wwdg.h@189:f392fc9709a3, 2019-02-20 (annotated)

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

Who changed what in which revision?

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