mbed official / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

TARGET_NUCLEO_F756ZG/TARGET_STM/TARGET_STM32F7/device/stm32f7xx_hal_iwdg.h@163:e59c8e839560, 2018-03-20 (annotated)

Committer:
AnnaBridge
Date:
Tue Mar 20 13:30:58 2018 +0000
Revision:
163:e59c8e839560
Parent:
156:ff21514d8981 
mbed library. Release version 160

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /**
AnnaBridge 156:ff21514d8981 2 ******************************************************************************
AnnaBridge 156:ff21514d8981 3 * @file stm32f7xx_hal_iwdg.h
AnnaBridge 156:ff21514d8981 4 * @author MCD Application Team
AnnaBridge 156:ff21514d8981 5 * @brief Header file of IWDG HAL module.
AnnaBridge 156:ff21514d8981 6 ******************************************************************************
AnnaBridge 156:ff21514d8981 7 * @attention
AnnaBridge 156:ff21514d8981 8 *
AnnaBridge 156:ff21514d8981 9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 156:ff21514d8981 12 * are permitted provided that the following conditions are met:
AnnaBridge 156:ff21514d8981 13 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 156:ff21514d8981 14 * this list of conditions and the following disclaimer.
AnnaBridge 156:ff21514d8981 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 156:ff21514d8981 16 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 156:ff21514d8981 17 * and/or other materials provided with the distribution.
AnnaBridge 156:ff21514d8981 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 156:ff21514d8981 19 * may be used to endorse or promote products derived from this software
AnnaBridge 156:ff21514d8981 20 * without specific prior written permission.
AnnaBridge 156:ff21514d8981 21 *
AnnaBridge 156:ff21514d8981 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 156:ff21514d8981 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 156:ff21514d8981 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 156:ff21514d8981 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 156:ff21514d8981 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 156:ff21514d8981 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 156:ff21514d8981 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 156:ff21514d8981 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 156:ff21514d8981 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 156:ff21514d8981 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 156:ff21514d8981 32 *
AnnaBridge 156:ff21514d8981 33 ******************************************************************************
AnnaBridge 156:ff21514d8981 34 */
AnnaBridge 156:ff21514d8981 35
AnnaBridge 156:ff21514d8981 36 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 156:ff21514d8981 37 #ifndef __STM32F7xx_HAL_IWDG_H
AnnaBridge 156:ff21514d8981 38 #define __STM32F7xx_HAL_IWDG_H
AnnaBridge 156:ff21514d8981 39
AnnaBridge 156:ff21514d8981 40 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 41 extern "C" {
AnnaBridge 156:ff21514d8981 42 #endif
AnnaBridge 156:ff21514d8981 43
AnnaBridge 156:ff21514d8981 44 /* Includes ------------------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 45 #include "stm32f7xx_hal_def.h"
AnnaBridge 156:ff21514d8981 46
AnnaBridge 156:ff21514d8981 47 /** @addtogroup STM32F7xx_HAL_Driver
AnnaBridge 156:ff21514d8981 48 * @{
AnnaBridge 156:ff21514d8981 49 */
AnnaBridge 156:ff21514d8981 50
AnnaBridge 156:ff21514d8981 51 /** @defgroup IWDG IWDG
AnnaBridge 156:ff21514d8981 52 * @{
AnnaBridge 156:ff21514d8981 53 */
AnnaBridge 156:ff21514d8981 54
AnnaBridge 156:ff21514d8981 55 /* Exported types ------------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 56 /** @defgroup IWDG_Exported_Types IWDG Exported Types
AnnaBridge 156:ff21514d8981 57 * @{
AnnaBridge 156:ff21514d8981 58 */
AnnaBridge 156:ff21514d8981 59
AnnaBridge 156:ff21514d8981 60 /**
AnnaBridge 156:ff21514d8981 61 * @brief IWDG Init structure definition
AnnaBridge 156:ff21514d8981 62 */
AnnaBridge 156:ff21514d8981 63 typedef struct
AnnaBridge 156:ff21514d8981 64 {
AnnaBridge 156:ff21514d8981 65 uint32_t Prescaler; /*!< Select the prescaler of the IWDG.
AnnaBridge 156:ff21514d8981 66 This parameter can be a value of @ref IWDG_Prescaler */
AnnaBridge 156:ff21514d8981 67
AnnaBridge 156:ff21514d8981 68 uint32_t Reload; /*!< Specifies the IWDG down-counter reload value.
AnnaBridge 156:ff21514d8981 69 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
AnnaBridge 156:ff21514d8981 70
AnnaBridge 156:ff21514d8981 71 uint32_t Window; /*!< Specifies the window value to be compared to the down-counter.
AnnaBridge 156:ff21514d8981 72 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
AnnaBridge 156:ff21514d8981 73
AnnaBridge 156:ff21514d8981 74 } IWDG_InitTypeDef;
AnnaBridge 156:ff21514d8981 75
AnnaBridge 156:ff21514d8981 76 /**
AnnaBridge 156:ff21514d8981 77 * @brief IWDG Handle Structure definition
AnnaBridge 156:ff21514d8981 78 */
AnnaBridge 156:ff21514d8981 79 typedef struct
AnnaBridge 156:ff21514d8981 80 {
AnnaBridge 156:ff21514d8981 81 IWDG_TypeDef *Instance; /*!< Register base address */
AnnaBridge 156:ff21514d8981 82
AnnaBridge 156:ff21514d8981 83 IWDG_InitTypeDef Init; /*!< IWDG required parameters */
AnnaBridge 156:ff21514d8981 84
AnnaBridge 156:ff21514d8981 85 }IWDG_HandleTypeDef;
AnnaBridge 156:ff21514d8981 86
AnnaBridge 156:ff21514d8981 87 /**
AnnaBridge 156:ff21514d8981 88 * @}
AnnaBridge 156:ff21514d8981 89 */
AnnaBridge 156:ff21514d8981 90
AnnaBridge 156:ff21514d8981 91 /* Exported constants --------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 92 /** @defgroup IWDG_Exported_Constants IWDG Exported Constants
AnnaBridge 156:ff21514d8981 93 * @{
AnnaBridge 156:ff21514d8981 94 */
AnnaBridge 156:ff21514d8981 95
AnnaBridge 156:ff21514d8981 96 /** @defgroup IWDG_Prescaler IWDG Prescaler
AnnaBridge 156:ff21514d8981 97 * @{
AnnaBridge 156:ff21514d8981 98 */
AnnaBridge 156:ff21514d8981 99 #define IWDG_PRESCALER_4 0x00000000u /*!< IWDG prescaler set to 4 */
AnnaBridge 156:ff21514d8981 100 #define IWDG_PRESCALER_8 IWDG_PR_PR_0 /*!< IWDG prescaler set to 8 */
AnnaBridge 156:ff21514d8981 101 #define IWDG_PRESCALER_16 IWDG_PR_PR_1 /*!< IWDG prescaler set to 16 */
AnnaBridge 156:ff21514d8981 102 #define IWDG_PRESCALER_32 (IWDG_PR_PR_1 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 32 */
AnnaBridge 156:ff21514d8981 103 #define IWDG_PRESCALER_64 IWDG_PR_PR_2 /*!< IWDG prescaler set to 64 */
AnnaBridge 156:ff21514d8981 104 #define IWDG_PRESCALER_128 (IWDG_PR_PR_2 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 128 */
AnnaBridge 156:ff21514d8981 105 #define IWDG_PRESCALER_256 (IWDG_PR_PR_2 | IWDG_PR_PR_1) /*!< IWDG prescaler set to 256 */
AnnaBridge 156:ff21514d8981 106 /**
AnnaBridge 156:ff21514d8981 107 * @}
AnnaBridge 156:ff21514d8981 108 */
AnnaBridge 156:ff21514d8981 109
AnnaBridge 156:ff21514d8981 110 /** @defgroup IWDG_Window_option IWDG Window option
AnnaBridge 156:ff21514d8981 111 * @{
AnnaBridge 156:ff21514d8981 112 */
AnnaBridge 156:ff21514d8981 113 #define IWDG_WINDOW_DISABLE IWDG_WINR_WIN
AnnaBridge 156:ff21514d8981 114 /**
AnnaBridge 156:ff21514d8981 115 * @}
AnnaBridge 156:ff21514d8981 116 */
AnnaBridge 156:ff21514d8981 117
AnnaBridge 156:ff21514d8981 118 /**
AnnaBridge 156:ff21514d8981 119 * @}
AnnaBridge 156:ff21514d8981 120 */
AnnaBridge 156:ff21514d8981 121
AnnaBridge 156:ff21514d8981 122 /* Exported macros -----------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 123 /** @defgroup IWDG_Exported_Macros IWDG Exported Macros
AnnaBridge 156:ff21514d8981 124 * @{
AnnaBridge 156:ff21514d8981 125 */
AnnaBridge 156:ff21514d8981 126
AnnaBridge 156:ff21514d8981 127 /**
AnnaBridge 156:ff21514d8981 128 * @brief Enable the IWDG peripheral.
AnnaBridge 163:e59c8e839560 129 * @param __HANDLE__ IWDG handle
AnnaBridge 156:ff21514d8981 130 * @retval None
AnnaBridge 156:ff21514d8981 131 */
AnnaBridge 156:ff21514d8981 132 #define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_ENABLE)
AnnaBridge 156:ff21514d8981 133
AnnaBridge 156:ff21514d8981 134 /**
AnnaBridge 156:ff21514d8981 135 * @brief Reload IWDG counter with value defined in the reload register
AnnaBridge 156:ff21514d8981 136 * (write access to IWDG_PR, IWDG_RLR & IWDG_WINR registers disabled).
AnnaBridge 163:e59c8e839560 137 * @param __HANDLE__ IWDG handle
AnnaBridge 156:ff21514d8981 138 * @retval None
AnnaBridge 156:ff21514d8981 139 */
AnnaBridge 156:ff21514d8981 140 #define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_RELOAD)
AnnaBridge 156:ff21514d8981 141
AnnaBridge 156:ff21514d8981 142 /**
AnnaBridge 156:ff21514d8981 143 * @}
AnnaBridge 156:ff21514d8981 144 */
AnnaBridge 156:ff21514d8981 145
AnnaBridge 156:ff21514d8981 146 /* Exported functions --------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 147 /** @defgroup IWDG_Exported_Functions IWDG Exported Functions
AnnaBridge 156:ff21514d8981 148 * @{
AnnaBridge 156:ff21514d8981 149 */
AnnaBridge 156:ff21514d8981 150
AnnaBridge 156:ff21514d8981 151 /** @defgroup IWDG_Exported_Functions_Group1 Initialization and Start functions
AnnaBridge 156:ff21514d8981 152 * @{
AnnaBridge 156:ff21514d8981 153 */
AnnaBridge 156:ff21514d8981 154 /* Initialization/Start functions ********************************************/
AnnaBridge 156:ff21514d8981 155 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
AnnaBridge 156:ff21514d8981 156 /**
AnnaBridge 156:ff21514d8981 157 * @}
AnnaBridge 156:ff21514d8981 158 */
AnnaBridge 156:ff21514d8981 159
AnnaBridge 156:ff21514d8981 160 /** @defgroup IWDG_Exported_Functions_Group2 IO operation functions
AnnaBridge 156:ff21514d8981 161 * @{
AnnaBridge 156:ff21514d8981 162 */
AnnaBridge 156:ff21514d8981 163 /* I/O operation functions ****************************************************/
AnnaBridge 156:ff21514d8981 164 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
AnnaBridge 156:ff21514d8981 165 /**
AnnaBridge 156:ff21514d8981 166 * @}
AnnaBridge 156:ff21514d8981 167 */
AnnaBridge 156:ff21514d8981 168
AnnaBridge 156:ff21514d8981 169 /**
AnnaBridge 156:ff21514d8981 170 * @}
AnnaBridge 156:ff21514d8981 171 */
AnnaBridge 156:ff21514d8981 172
AnnaBridge 156:ff21514d8981 173 /* Private constants ---------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 174 /** @defgroup IWDG_Private_Constants IWDG Private Constants
AnnaBridge 156:ff21514d8981 175 * @{
AnnaBridge 156:ff21514d8981 176 */
AnnaBridge 156:ff21514d8981 177
AnnaBridge 156:ff21514d8981 178 /**
AnnaBridge 156:ff21514d8981 179 * @brief IWDG Key Register BitMask
AnnaBridge 156:ff21514d8981 180 */
AnnaBridge 156:ff21514d8981 181 #define IWDG_KEY_RELOAD 0x0000AAAAu /*!< IWDG Reload Counter Enable */
AnnaBridge 156:ff21514d8981 182 #define IWDG_KEY_ENABLE 0x0000CCCCu /*!< IWDG Peripheral Enable */
AnnaBridge 156:ff21514d8981 183 #define IWDG_KEY_WRITE_ACCESS_ENABLE 0x00005555u /*!< IWDG KR Write Access Enable */
AnnaBridge 156:ff21514d8981 184 #define IWDG_KEY_WRITE_ACCESS_DISABLE 0x00000000u /*!< IWDG KR Write Access Disable */
AnnaBridge 156:ff21514d8981 185
AnnaBridge 156:ff21514d8981 186 /**
AnnaBridge 156:ff21514d8981 187 * @}
AnnaBridge 156:ff21514d8981 188 */
AnnaBridge 156:ff21514d8981 189
AnnaBridge 156:ff21514d8981 190 /* Private macros ------------------------------------------------------------*/
AnnaBridge 156:ff21514d8981 191 /** @defgroup IWDG_Private_Macros IWDG Private Macros
AnnaBridge 156:ff21514d8981 192 * @{
AnnaBridge 156:ff21514d8981 193 */
AnnaBridge 156:ff21514d8981 194
AnnaBridge 156:ff21514d8981 195 /**
AnnaBridge 156:ff21514d8981 196 * @brief Enable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers.
AnnaBridge 163:e59c8e839560 197 * @param __HANDLE__ IWDG handle
AnnaBridge 156:ff21514d8981 198 * @retval None
AnnaBridge 156:ff21514d8981 199 */
AnnaBridge 156:ff21514d8981 200 #define IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_ENABLE)
AnnaBridge 156:ff21514d8981 201
AnnaBridge 156:ff21514d8981 202 /**
AnnaBridge 156:ff21514d8981 203 * @brief Disable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers.
AnnaBridge 163:e59c8e839560 204 * @param __HANDLE__ IWDG handle
AnnaBridge 156:ff21514d8981 205 * @retval None
AnnaBridge 156:ff21514d8981 206 */
AnnaBridge 156:ff21514d8981 207 #define IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_DISABLE)
AnnaBridge 156:ff21514d8981 208
AnnaBridge 156:ff21514d8981 209 /**
AnnaBridge 156:ff21514d8981 210 * @brief Check IWDG prescaler value.
AnnaBridge 163:e59c8e839560 211 * @param __PRESCALER__ IWDG prescaler value
AnnaBridge 156:ff21514d8981 212 * @retval None
AnnaBridge 156:ff21514d8981 213 */
AnnaBridge 156:ff21514d8981 214 #define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4) || \
AnnaBridge 156:ff21514d8981 215 ((__PRESCALER__) == IWDG_PRESCALER_8) || \
AnnaBridge 156:ff21514d8981 216 ((__PRESCALER__) == IWDG_PRESCALER_16) || \
AnnaBridge 156:ff21514d8981 217 ((__PRESCALER__) == IWDG_PRESCALER_32) || \
AnnaBridge 156:ff21514d8981 218 ((__PRESCALER__) == IWDG_PRESCALER_64) || \
AnnaBridge 156:ff21514d8981 219 ((__PRESCALER__) == IWDG_PRESCALER_128)|| \
AnnaBridge 156:ff21514d8981 220 ((__PRESCALER__) == IWDG_PRESCALER_256))
AnnaBridge 156:ff21514d8981 221
AnnaBridge 156:ff21514d8981 222 /**
AnnaBridge 156:ff21514d8981 223 * @brief Check IWDG reload value.
AnnaBridge 163:e59c8e839560 224 * @param __RELOAD__ IWDG reload value
AnnaBridge 156:ff21514d8981 225 * @retval None
AnnaBridge 156:ff21514d8981 226 */
AnnaBridge 156:ff21514d8981 227 #define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= IWDG_RLR_RL)
AnnaBridge 156:ff21514d8981 228
AnnaBridge 156:ff21514d8981 229 /**
AnnaBridge 156:ff21514d8981 230 * @brief Check IWDG window value.
AnnaBridge 163:e59c8e839560 231 * @param __WINDOW__ IWDG window value
AnnaBridge 156:ff21514d8981 232 * @retval None
AnnaBridge 156:ff21514d8981 233 */
AnnaBridge 156:ff21514d8981 234 #define IS_IWDG_WINDOW(__WINDOW__) ((__WINDOW__) <= IWDG_WINR_WIN)
AnnaBridge 156:ff21514d8981 235
AnnaBridge 156:ff21514d8981 236 /**
AnnaBridge 156:ff21514d8981 237 * @}
AnnaBridge 156:ff21514d8981 238 */
AnnaBridge 156:ff21514d8981 239
AnnaBridge 156:ff21514d8981 240 /**
AnnaBridge 156:ff21514d8981 241 * @}
AnnaBridge 156:ff21514d8981 242 */
AnnaBridge 156:ff21514d8981 243
AnnaBridge 156:ff21514d8981 244 /**
AnnaBridge 156:ff21514d8981 245 * @}
AnnaBridge 156:ff21514d8981 246 */
AnnaBridge 156:ff21514d8981 247
AnnaBridge 156:ff21514d8981 248
AnnaBridge 156:ff21514d8981 249 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 250 }
AnnaBridge 156:ff21514d8981 251 #endif
AnnaBridge 156:ff21514d8981 252
AnnaBridge 156:ff21514d8981 253 #endif /* __STM32F7xx_HAL_IWDG_H */
AnnaBridge 156:ff21514d8981 254
AnnaBridge 156:ff21514d8981 255 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/