Increment eeprom version
[betaflight.git] / lib / main / STM32F1 / Drivers / STM32F1xx_HAL_Driver / Inc / stm32f1xx_hal_iwdg.h
blob775d6675bbce5229702e9ce2d8b5e913589ba0c5
1 /**
2 ******************************************************************************
3 * @file stm32f1xx_hal_iwdg.h
4 * @author MCD Application Team
5 * @version V1.1.1
6 * @date 12-May-2017
7 * @brief Header file of IWDG HAL module.
8 ******************************************************************************
9 * @attention
11 * <h2><center>&copy; COPYRIGHT(c) 2016 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
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f1xx_hal_def.h"
49 /** @addtogroup STM32F1xx_HAL_Driver
50 * @{
53 /** @addtogroup IWDG
54 * @{
57 /* Exported types ------------------------------------------------------------*/
58 /** @defgroup IWDG_Exported_Types IWDG Exported Types
59 * @{
62 /**
63 * @brief IWDG Init structure definition
65 typedef struct
67 uint32_t Prescaler; /*!< Select the prescaler of the IWDG.
68 This parameter can be a value of @ref IWDG_Prescaler */
70 uint32_t Reload; /*!< Specifies the IWDG down-counter reload value.
71 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
73 } IWDG_InitTypeDef;
75 /**
76 * @brief IWDG Handle Structure definition
78 typedef struct
80 IWDG_TypeDef *Instance; /*!< Register base address */
82 IWDG_InitTypeDef Init; /*!< IWDG required parameters */
84 }IWDG_HandleTypeDef;
86 /**
87 * @}
90 /* Exported constants --------------------------------------------------------*/
91 /** @defgroup IWDG_Exported_Constants IWDG Exported Constants
92 * @{
95 /** @defgroup IWDG_Prescaler IWDG Prescaler
96 * @{
98 #define IWDG_PRESCALER_4 0x00000000U /*!< IWDG prescaler set to 4 */
99 #define IWDG_PRESCALER_8 IWDG_PR_PR_0 /*!< IWDG prescaler set to 8 */
100 #define IWDG_PRESCALER_16 IWDG_PR_PR_1 /*!< IWDG prescaler set to 16 */
101 #define IWDG_PRESCALER_32 (IWDG_PR_PR_1 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 32 */
102 #define IWDG_PRESCALER_64 IWDG_PR_PR_2 /*!< IWDG prescaler set to 64 */
103 #define IWDG_PRESCALER_128 (IWDG_PR_PR_2 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 128 */
104 #define IWDG_PRESCALER_256 (IWDG_PR_PR_2 | IWDG_PR_PR_1) /*!< IWDG prescaler set to 256 */
106 * @}
110 * @}
114 /* Exported macros -----------------------------------------------------------*/
115 /** @defgroup IWDG_Exported_Macros IWDG Exported Macros
116 * @{
120 * @brief Enable the IWDG peripheral.
121 * @param __HANDLE__ IWDG handle
122 * @retval None
124 #define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_ENABLE)
127 * @brief Reload IWDG counter with value defined in the reload register
128 * (write access to IWDG_PR & IWDG_RLR registers disabled).
129 * @param __HANDLE__ IWDG handle
130 * @retval None
132 #define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_RELOAD)
135 * @}
138 /* Exported functions --------------------------------------------------------*/
139 /** @defgroup IWDG_Exported_Functions IWDG Exported Functions
140 * @{
143 /** @defgroup IWDG_Exported_Functions_Group1 Initialization and Start functions
144 * @{
146 /* Initialization/Start functions ********************************************/
147 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
149 * @}
152 /** @defgroup IWDG_Exported_Functions_Group2 IO operation functions
153 * @{
155 /* I/O operation functions ****************************************************/
156 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
158 * @}
162 * @}
165 /* Private constants ---------------------------------------------------------*/
166 /** @defgroup IWDG_Private_Constants IWDG Private Constants
167 * @{
171 * @brief IWDG Key Register BitMask
173 #define IWDG_KEY_RELOAD 0x0000AAAAU /*!< IWDG Reload Counter Enable */
174 #define IWDG_KEY_ENABLE 0x0000CCCCU /*!< IWDG Peripheral Enable */
175 #define IWDG_KEY_WRITE_ACCESS_ENABLE 0x00005555U /*!< IWDG KR Write Access Enable */
176 #define IWDG_KEY_WRITE_ACCESS_DISABLE 0x00000000U /*!< IWDG KR Write Access Disable */
179 * @}
182 /* Private macros ------------------------------------------------------------*/
183 /** @defgroup IWDG_Private_Macros IWDG Private Macros
184 * @{
188 * @brief Enable write access to IWDG_PR and IWDG_RLR registers.
189 * @param __HANDLE__ IWDG handle
190 * @retval None
192 #define IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_ENABLE)
195 * @brief Disable write access to IWDG_PR and IWDG_RLR registers.
196 * @param __HANDLE__ IWDG handle
197 * @retval None
199 #define IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_DISABLE)
202 * @brief Check IWDG prescaler value.
203 * @param __PRESCALER__ IWDG prescaler value
204 * @retval None
206 #define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4) || \
207 ((__PRESCALER__) == IWDG_PRESCALER_8) || \
208 ((__PRESCALER__) == IWDG_PRESCALER_16) || \
209 ((__PRESCALER__) == IWDG_PRESCALER_32) || \
210 ((__PRESCALER__) == IWDG_PRESCALER_64) || \
211 ((__PRESCALER__) == IWDG_PRESCALER_128)|| \
212 ((__PRESCALER__) == IWDG_PRESCALER_256))
215 * @brief Check IWDG reload value.
216 * @param __RELOAD__ IWDG reload value
217 * @retval None
219 #define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= IWDG_RLR_RL)
222 * @}
226 * @}
230 * @}
234 #ifdef __cplusplus
236 #endif
238 #endif /* __STM32F1xx_HAL_IWDG_H */
240 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/