marcus chiou / mbed-src

mbed library sources

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_wwdg.h@380:510f0c3515e3, 2014-11-03 (annotated)

Committer:
mbed_official
Date:
Mon Nov 03 10:15:07 2014 +0000
Revision:
380:510f0c3515e3
Parent:
targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_wwdg.h@369:2e96f1b71984
Child:
532:fe11edbda85c
Synchronized with git revision 417f470ba9f4882d7079611cbc576afd9c49b0ef



Full URL: https://github.com/mbedmicro/mbed/commit/417f470ba9f4882d7079611cbc576afd9c49b0ef/



Targets: Factorisation of NUCLEO_F401RE and F411RE cmsis folders

Who changed what in which revision?

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