雄介 太田 / mbed

mbed(SerialHalfDuplex入り)

Fork of mbed by mbed official

TARGET_MTS_MDOT_F411RE/stm32f4xx_hal_wwdg.h@98:01a414ca7d6d, 2015-04-08 (annotated)

Committer:
yusuke_kyo
Date:
Wed Apr 08 08:04:18 2015 +0000
Revision:
98:01a414ca7d6d
Parent:
93:e188a91d3eaa 
remove SerialHalfDuplex.h

Who changed what in which revision?

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