2 ******************************************************************************
3 * @file stm32f1xx_hal_iwdg.h
4 * @author MCD Application Team
6 * @date 15-December-2014
7 * @brief Header file of IWDG HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F1xx_HAL_IWDG_H
40 #define __STM32F1xx_HAL_IWDG_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f1xx_hal_def.h"
49 /** @addtogroup STM32F1xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
59 /** @defgroup IWDG_Exported_Types IWDG Exported Types
64 * @brief IWDG HAL State Structure definition
68 HAL_IWDG_STATE_RESET = 0x00, /*!< IWDG not yet initialized or disabled */
69 HAL_IWDG_STATE_READY = 0x01, /*!< IWDG initialized and ready for use */
70 HAL_IWDG_STATE_BUSY = 0x02, /*!< IWDG internal process is ongoing */
71 HAL_IWDG_STATE_TIMEOUT = 0x03, /*!< IWDG timeout state */
72 HAL_IWDG_STATE_ERROR = 0x04 /*!< IWDG error state */
74 }HAL_IWDG_StateTypeDef;
77 * @brief IWDG Init structure definition
81 uint32_t Prescaler; /*!< Select the prescaler of the IWDG.
82 This parameter can be a value of @ref IWDG_Prescaler */
84 uint32_t Reload; /*!< Specifies the IWDG down-counter reload value.
85 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
90 * @brief IWDG Handle Structure definition
94 IWDG_TypeDef *Instance; /*!< Register base address */
96 IWDG_InitTypeDef Init; /*!< IWDG required parameters */
98 HAL_LockTypeDef Lock; /*!< IWDG Locking object */
100 __IO HAL_IWDG_StateTypeDef State; /*!< IWDG communication state */
108 /* Exported constants --------------------------------------------------------*/
110 /** @defgroup IWDG_Exported_Constants IWDG Exported Constants
114 /** @defgroup IWDG_Registers_BitMask IWDG Registers BitMask
115 * @brief IWDG registers bit mask
118 /* --- KR Register ---*/
119 /* KR register bit mask */
120 #define IWDG_KEY_RELOAD ((uint32_t)0xAAAA) /*!< IWDG Reload Counter Enable */
121 #define IWDG_KEY_ENABLE ((uint32_t)0xCCCC) /*!< IWDG Peripheral Enable */
122 #define IWDG_KEY_WRITE_ACCESS_ENABLE ((uint32_t)0x5555) /*!< IWDG KR Write Access Enable */
123 #define IWDG_KEY_WRITE_ACCESS_DISABLE ((uint32_t)0x0000) /*!< IWDG KR Write Access Disable */
129 /** @defgroup IWDG_Flag_definition IWDG Flag definition
132 #define IWDG_FLAG_PVU ((uint32_t)IWDG_SR_PVU) /*!< Watchdog counter prescaler value update Flag */
133 #define IWDG_FLAG_RVU ((uint32_t)IWDG_SR_RVU) /*!< Watchdog counter reload value update Flag */
139 /** @defgroup IWDG_Prescaler IWDG Prescaler
142 #define IWDG_PRESCALER_4 ((uint8_t)0x00) /*!< IWDG prescaler set to 4 */
143 #define IWDG_PRESCALER_8 ((uint8_t)(IWDG_PR_PR_0)) /*!< IWDG prescaler set to 8 */
144 #define IWDG_PRESCALER_16 ((uint8_t)(IWDG_PR_PR_1)) /*!< IWDG prescaler set to 16 */
145 #define IWDG_PRESCALER_32 ((uint8_t)(IWDG_PR_PR_1 | IWDG_PR_PR_0)) /*!< IWDG prescaler set to 32 */
146 #define IWDG_PRESCALER_64 ((uint8_t)(IWDG_PR_PR_2)) /*!< IWDG prescaler set to 64 */
147 #define IWDG_PRESCALER_128 ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_0)) /*!< IWDG prescaler set to 128 */
148 #define IWDG_PRESCALER_256 ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_1)) /*!< IWDG prescaler set to 256 */
159 /* Exported macros -----------------------------------------------------------*/
161 /** @defgroup IWDG_Exported_Macros IWDG Exported Macros
165 /** @brief Reset IWDG handle state
166 * @param __HANDLE__: IWDG handle.
169 #define __HAL_IWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IWDG_STATE_RESET)
172 * @brief Enables the IWDG peripheral.
173 * @param __HANDLE__: IWDG handle
176 #define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_ENABLE)
179 * @brief Reloads IWDG counter with value defined in the reload register
180 * (write access to IWDG_PR and IWDG_RLR registers disabled).
181 * @param __HANDLE__: IWDG handle
184 #define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_RELOAD)
189 * @brief Gets the selected IWDG's flag status.
190 * @param __HANDLE__: IWDG handle
191 * @param __FLAG__: specifies the flag to check.
192 * This parameter can be one of the following values:
193 * @arg IWDG_FLAG_PVU: Watchdog counter reload value update flag
194 * @arg IWDG_FLAG_RVU: Watchdog counter prescaler value flag
195 * @retval The new state of __FLAG__ (TRUE or FALSE).
197 #define __HAL_IWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
203 /* Private macro -------------------------------------------------------------*/
205 /** @defgroup IWDG_Private_Macros IWDG Private Macros
211 * @brief Enables write access to IWDG_PR and IWDG_RLR registers.
212 * @param __HANDLE__: IWDG handle
215 #define IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_ENABLE)
218 * @brief Disables write access to IWDG_PR and IWDG_RLR registers.
219 * @param __HANDLE__: IWDG handle
222 #define IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_DISABLE)
225 #define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4) || \
226 ((__PRESCALER__) == IWDG_PRESCALER_8) || \
227 ((__PRESCALER__) == IWDG_PRESCALER_16) || \
228 ((__PRESCALER__) == IWDG_PRESCALER_32) || \
229 ((__PRESCALER__) == IWDG_PRESCALER_64) || \
230 ((__PRESCALER__) == IWDG_PRESCALER_128)|| \
231 ((__PRESCALER__) == IWDG_PRESCALER_256))
234 #define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= 0xFFF)
243 /* Exported functions --------------------------------------------------------*/
245 /** @addtogroup IWDG_Exported_Functions
249 /** @addtogroup IWDG_Exported_Functions_Group1
252 /* Initialization/de-initialization functions ********************************/
253 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
254 void HAL_IWDG_MspInit(IWDG_HandleTypeDef *hiwdg);
260 /** @addtogroup IWDG_Exported_Functions_Group2
263 /* I/O operation functions ****************************************************/
264 HAL_StatusTypeDef HAL_IWDG_Start(IWDG_HandleTypeDef *hiwdg);
265 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
271 /** @addtogroup IWDG_Exported_Functions_Group3
274 /* Peripheral State functions ************************************************/
275 HAL_IWDG_StateTypeDef HAL_IWDG_GetState(IWDG_HandleTypeDef *hiwdg);
297 #endif /* __STM32F1xx_HAL_IWDG_H */
299 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/