Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_MOTE_L152RC/stm32l1xx_hal_wwdg.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
112:6f327212ef96 
.

Who changed what in which revision?

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