Julien Kern / mbed

mbed library

Dependents:   Printf

Fork of mbed by mbed official

TARGET_ARCH_MAX/stm32f4xx_hal_wwdg.h@89:552587b429a1, 2014-09-12 (annotated)

Committer:
bogdanm
Date:
Fri Sep 12 16:41:52 2014 +0100
Revision:
89:552587b429a1
Child:
92:4fc01daae5a5
Release 89 of the mbed library



Main changes:



- low power optimizations for Nordic targets

- code structure changes for Freescale K64F targets

- bug fixes in various backends

Who changed what in which revision?

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