STM32F439xx HAL User Manual
|
00001 /** 00002 ****************************************************************************** 00003 * @file stm32f4xx_hal_wwdg.h 00004 * @author MCD Application Team 00005 * @brief Header file of WWDG HAL module. 00006 ****************************************************************************** 00007 * @attention 00008 * 00009 * <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> 00010 * 00011 * Redistribution and use in source and binary forms, with or without modification, 00012 * are permitted provided that the following conditions are met: 00013 * 1. Redistributions of source code must retain the above copyright notice, 00014 * this list of conditions and the following disclaimer. 00015 * 2. Redistributions in binary form must reproduce the above copyright notice, 00016 * this list of conditions and the following disclaimer in the documentation 00017 * and/or other materials provided with the distribution. 00018 * 3. Neither the name of STMicroelectronics nor the names of its contributors 00019 * may be used to endorse or promote products derived from this software 00020 * without specific prior written permission. 00021 * 00022 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00023 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00024 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00025 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 00026 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00027 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 00028 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00029 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00030 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00031 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00032 * 00033 ****************************************************************************** 00034 */ 00035 00036 /* Define to prevent recursive inclusion -------------------------------------*/ 00037 #ifndef __STM32F4xx_HAL_WWDG_H 00038 #define __STM32F4xx_HAL_WWDG_H 00039 00040 #ifdef __cplusplus 00041 extern "C" { 00042 #endif 00043 00044 /* Includes ------------------------------------------------------------------*/ 00045 #include "stm32f4xx_hal_def.h" 00046 00047 /** @addtogroup STM32F4xx_HAL_Driver 00048 * @{ 00049 */ 00050 00051 /** @addtogroup WWDG 00052 * @{ 00053 */ 00054 00055 /* Exported types ------------------------------------------------------------*/ 00056 /** @defgroup WWDG_Exported_Types WWDG Exported Types 00057 * @{ 00058 */ 00059 00060 /** 00061 * @brief WWDG Init structure definition 00062 */ 00063 typedef struct 00064 { 00065 uint32_t Prescaler; /*!< Specifies the prescaler value of the WWDG. 00066 This parameter can be a value of @ref WWDG_Prescaler */ 00067 00068 uint32_t Window; /*!< Specifies the WWDG window value to be compared to the downcounter. 00069 This parameter must be a number Min_Data = 0x40 and Max_Data = 0x7F */ 00070 00071 uint32_t Counter; /*!< Specifies the WWDG free-running downcounter value. 00072 This parameter must be a number between Min_Data = 0x40 and Max_Data = 0x7F */ 00073 00074 uint32_t EWIMode ; /*!< Specifies if WWDG Early Wakeup Interupt is enable or not. 00075 This parameter can be a value of @ref WWDG_EWI_Mode */ 00076 00077 }WWDG_InitTypeDef; 00078 00079 /** 00080 * @brief WWDG handle Structure definition 00081 */ 00082 typedef struct 00083 { 00084 WWDG_TypeDef *Instance; /*!< Register base address */ 00085 00086 WWDG_InitTypeDef Init; /*!< WWDG required parameters */ 00087 00088 }WWDG_HandleTypeDef; 00089 /** 00090 * @} 00091 */ 00092 00093 /* Exported constants --------------------------------------------------------*/ 00094 00095 /** @defgroup WWDG_Exported_Constants WWDG Exported Constants 00096 * @{ 00097 */ 00098 00099 /** @defgroup WWDG_Interrupt_definition WWDG Interrupt definition 00100 * @{ 00101 */ 00102 #define WWDG_IT_EWI WWDG_CFR_EWI /*!< Early wakeup interrupt */ 00103 /** 00104 * @} 00105 */ 00106 00107 /** @defgroup WWDG_Flag_definition WWDG Flag definition 00108 * @brief WWDG Flag definition 00109 * @{ 00110 */ 00111 #define WWDG_FLAG_EWIF WWDG_SR_EWIF /*!< Early wakeup interrupt flag */ 00112 /** 00113 * @} 00114 */ 00115 00116 /** @defgroup WWDG_Prescaler WWDG Prescaler 00117 * @{ 00118 */ 00119 #define WWDG_PRESCALER_1 0x00000000U /*!< WWDG counter clock = (PCLK1/4096)/1 */ 00120 #define WWDG_PRESCALER_2 WWDG_CFR_WDGTB0 /*!< WWDG counter clock = (PCLK1/4096)/2 */ 00121 #define WWDG_PRESCALER_4 WWDG_CFR_WDGTB1 /*!< WWDG counter clock = (PCLK1/4096)/4 */ 00122 #define WWDG_PRESCALER_8 WWDG_CFR_WDGTB /*!< WWDG counter clock = (PCLK1/4096)/8 */ 00123 /** 00124 * @} 00125 */ 00126 00127 /** @defgroup WWDG_EWI_Mode WWDG Early Wakeup Interrupt Mode 00128 * @{ 00129 */ 00130 #define WWDG_EWI_DISABLE 0x00000000U /*!< EWI Disable */ 00131 #define WWDG_EWI_ENABLE WWDG_CFR_EWI /*!< EWI Enable */ 00132 /** 00133 * @} 00134 */ 00135 00136 /** 00137 * @} 00138 */ 00139 00140 /* Private macros ------------------------------------------------------------*/ 00141 00142 /** @defgroup WWDG_Private_Macros WWDG Private Macros 00143 * @{ 00144 */ 00145 #define IS_WWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == WWDG_PRESCALER_1) || \ 00146 ((__PRESCALER__) == WWDG_PRESCALER_2) || \ 00147 ((__PRESCALER__) == WWDG_PRESCALER_4) || \ 00148 ((__PRESCALER__) == WWDG_PRESCALER_8)) 00149 00150 #define IS_WWDG_WINDOW(__WINDOW__) (((__WINDOW__) >= WWDG_CFR_W_6) && ((__WINDOW__) <= WWDG_CFR_W)) 00151 00152 #define IS_WWDG_COUNTER(__COUNTER__) (((__COUNTER__) >= WWDG_CR_T_6) && ((__COUNTER__) <= WWDG_CR_T)) 00153 00154 #define IS_WWDG_EWI_MODE(__MODE__) (((__MODE__) == WWDG_EWI_ENABLE) || \ 00155 ((__MODE__) == WWDG_EWI_DISABLE)) 00156 /** 00157 * @} 00158 */ 00159 00160 00161 /* Exported macros ------------------------------------------------------------*/ 00162 00163 /** @defgroup WWDG_Exported_Macros WWDG Exported Macros 00164 * @{ 00165 */ 00166 00167 /** 00168 * @brief Enables the WWDG peripheral. 00169 * @param __HANDLE__ WWDG handle 00170 * @retval None 00171 */ 00172 #define __HAL_WWDG_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, WWDG_CR_WDGA) 00173 00174 /** 00175 * @brief Enables the WWDG early wakeup interrupt. 00176 * @param __HANDLE__ WWDG handle 00177 * @param __INTERRUPT__ specifies the interrupt to enable. 00178 * This parameter can be one of the following values: 00179 * @arg WWDG_IT_EWI: Early wakeup interrupt 00180 * @note Once enabled this interrupt cannot be disabled except by a system reset. 00181 * @retval None 00182 */ 00183 #define __HAL_WWDG_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CFR, (__INTERRUPT__)) 00184 00185 /** 00186 * @brief Checks whether the selected WWDG interrupt has occurred or not. 00187 * @param __HANDLE__ WWDG handle 00188 * @param __INTERRUPT__ specifies the it to check. 00189 * This parameter can be one of the following values: 00190 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt IT 00191 * @retval The new state of WWDG_FLAG (SET or RESET). 00192 */ 00193 #define __HAL_WWDG_GET_IT(__HANDLE__, __INTERRUPT__) __HAL_WWDG_GET_FLAG((__HANDLE__),(__INTERRUPT__)) 00194 00195 /** @brief Clear the WWDG's interrupt pending bits 00196 * bits to clear the selected interrupt pending bits. 00197 * @param __HANDLE__ WWDG handle 00198 * @param __INTERRUPT__ specifies the interrupt pending bit to clear. 00199 * This parameter can be one of the following values: 00200 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag 00201 */ 00202 #define __HAL_WWDG_CLEAR_IT(__HANDLE__, __INTERRUPT__) __HAL_WWDG_CLEAR_FLAG((__HANDLE__), (__INTERRUPT__)) 00203 00204 /** 00205 * @brief Check whether the specified WWDG flag is set or not. 00206 * @param __HANDLE__ WWDG handle 00207 * @param __FLAG__ specifies the flag to check. 00208 * This parameter can be one of the following values: 00209 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag 00210 * @retval The new state of WWDG_FLAG (SET or RESET). 00211 */ 00212 #define __HAL_WWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__)) 00213 00214 /** 00215 * @brief Clears the WWDG's pending flags. 00216 * @param __HANDLE__ WWDG handle 00217 * @param __FLAG__ specifies the flag to clear. 00218 * This parameter can be one of the following values: 00219 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag 00220 * @retval None 00221 */ 00222 #define __HAL_WWDG_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = ~(__FLAG__)) 00223 00224 /** @brief Checks if the specified WWDG interrupt source is enabled or disabled. 00225 * @param __HANDLE__ WWDG Handle. 00226 * @param __INTERRUPT__ specifies the WWDG interrupt source to check. 00227 * This parameter can be one of the following values: 00228 * @arg WWDG_IT_EWI: Early Wakeup Interrupt 00229 * @retval state of __INTERRUPT__ (TRUE or FALSE). 00230 */ 00231 #define __HAL_WWDG_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CFR & (__INTERRUPT__)) == (__INTERRUPT__)) 00232 00233 /** 00234 * @} 00235 */ 00236 00237 /* Exported functions --------------------------------------------------------*/ 00238 /** @addtogroup WWDG_Exported_Functions 00239 * @{ 00240 */ 00241 00242 /** @addtogroup WWDG_Exported_Functions_Group1 00243 * @{ 00244 */ 00245 /* Initialization/de-initialization functions **********************************/ 00246 HAL_StatusTypeDef HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg); 00247 void HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg); 00248 /** 00249 * @} 00250 */ 00251 00252 /** @addtogroup WWDG_Exported_Functions_Group2 00253 * @{ 00254 */ 00255 /* I/O operation functions ******************************************************/ 00256 HAL_StatusTypeDef HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg); 00257 void HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg); 00258 void HAL_WWDG_EarlyWakeupCallback(WWDG_HandleTypeDef* hwwdg); 00259 /** 00260 * @} 00261 */ 00262 00263 /** 00264 * @} 00265 */ 00266 00267 /** 00268 * @} 00269 */ 00270 00271 /** 00272 * @} 00273 */ 00274 00275 #ifdef __cplusplus 00276 } 00277 #endif 00278 00279 #endif /* __STM32F4xx_HAL_WWDG_H */ 00280 00281 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/