mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_H743ZI/TOOLCHAIN_ARM_MICRO/stm32h7xx_hal_iwdg.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 172:65be27845400 1 /**
AnnaBridge 172:65be27845400 2 ******************************************************************************
AnnaBridge 172:65be27845400 3 * @file stm32h7xx_hal_iwdg.h
AnnaBridge 172:65be27845400 4 * @author MCD Application Team
AnnaBridge 172:65be27845400 5 * @brief Header file of IWDG HAL module.
AnnaBridge 172:65be27845400 6 ******************************************************************************
AnnaBridge 172:65be27845400 7 * @attention
AnnaBridge 172:65be27845400 8 *
AnnaBridge 172:65be27845400 9 * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
AnnaBridge 172:65be27845400 10 * All rights reserved.</center></h2>
AnnaBridge 172:65be27845400 11 *
AnnaBridge 172:65be27845400 12 * This software component is licensed by ST under BSD 3-Clause license,
AnnaBridge 172:65be27845400 13 * the "License"; You may not use this file except in compliance with the
AnnaBridge 172:65be27845400 14 * License. You may obtain a copy of the License at:
AnnaBridge 172:65be27845400 15 * opensource.org/licenses/BSD-3-Clause
AnnaBridge 172:65be27845400 16 *
AnnaBridge 172:65be27845400 17 ******************************************************************************
AnnaBridge 172:65be27845400 18 */
AnnaBridge 172:65be27845400 19
AnnaBridge 172:65be27845400 20 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 172:65be27845400 21 #ifndef STM32H7xx_HAL_IWDG_H
AnnaBridge 172:65be27845400 22 #define STM32H7xx_HAL_IWDG_H
AnnaBridge 172:65be27845400 23
AnnaBridge 172:65be27845400 24 #ifdef __cplusplus
AnnaBridge 172:65be27845400 25 extern "C" {
AnnaBridge 172:65be27845400 26 #endif
AnnaBridge 172:65be27845400 27
AnnaBridge 172:65be27845400 28 /* Includes ------------------------------------------------------------------*/
AnnaBridge 172:65be27845400 29 #include "stm32h7xx_hal_def.h"
AnnaBridge 172:65be27845400 30
AnnaBridge 172:65be27845400 31 /** @addtogroup STM32H7xx_HAL_Driver
AnnaBridge 172:65be27845400 32 * @{
AnnaBridge 172:65be27845400 33 */
AnnaBridge 172:65be27845400 34
AnnaBridge 172:65be27845400 35 /** @defgroup IWDG IWDG
AnnaBridge 172:65be27845400 36 * @{
AnnaBridge 172:65be27845400 37 */
AnnaBridge 172:65be27845400 38
AnnaBridge 172:65be27845400 39 /* Exported types ------------------------------------------------------------*/
AnnaBridge 172:65be27845400 40 /** @defgroup IWDG_Exported_Types IWDG Exported Types
AnnaBridge 172:65be27845400 41 * @{
AnnaBridge 172:65be27845400 42 */
AnnaBridge 172:65be27845400 43
AnnaBridge 172:65be27845400 44 /**
AnnaBridge 172:65be27845400 45 * @brief IWDG Init structure definition
AnnaBridge 172:65be27845400 46 */
AnnaBridge 172:65be27845400 47 typedef struct
AnnaBridge 172:65be27845400 48 {
AnnaBridge 172:65be27845400 49 uint32_t Prescaler; /*!< Select the prescaler of the IWDG.
AnnaBridge 172:65be27845400 50 This parameter can be a value of @ref IWDG_Prescaler */
AnnaBridge 172:65be27845400 51
AnnaBridge 172:65be27845400 52 uint32_t Reload; /*!< Specifies the IWDG down-counter reload value.
AnnaBridge 172:65be27845400 53 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
AnnaBridge 172:65be27845400 54
AnnaBridge 172:65be27845400 55 uint32_t Window; /*!< Specifies the window value to be compared to the down-counter.
AnnaBridge 172:65be27845400 56 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
AnnaBridge 172:65be27845400 57
AnnaBridge 172:65be27845400 58 } IWDG_InitTypeDef;
AnnaBridge 172:65be27845400 59
AnnaBridge 172:65be27845400 60 /**
AnnaBridge 172:65be27845400 61 * @brief IWDG Handle Structure definition
AnnaBridge 172:65be27845400 62 */
AnnaBridge 172:65be27845400 63 typedef struct
AnnaBridge 172:65be27845400 64 {
AnnaBridge 172:65be27845400 65 IWDG_TypeDef *Instance; /*!< Register base address */
AnnaBridge 172:65be27845400 66
AnnaBridge 172:65be27845400 67 IWDG_InitTypeDef Init; /*!< IWDG required parameters */
AnnaBridge 172:65be27845400 68 } IWDG_HandleTypeDef;
AnnaBridge 172:65be27845400 69
AnnaBridge 172:65be27845400 70
AnnaBridge 172:65be27845400 71 /**
AnnaBridge 172:65be27845400 72 * @}
AnnaBridge 172:65be27845400 73 */
AnnaBridge 172:65be27845400 74
AnnaBridge 172:65be27845400 75 /* Exported constants --------------------------------------------------------*/
AnnaBridge 172:65be27845400 76 /** @defgroup IWDG_Exported_Constants IWDG Exported Constants
AnnaBridge 172:65be27845400 77 * @{
AnnaBridge 172:65be27845400 78 */
AnnaBridge 172:65be27845400 79
AnnaBridge 172:65be27845400 80 /** @defgroup IWDG_Prescaler IWDG Prescaler
AnnaBridge 172:65be27845400 81 * @{
AnnaBridge 172:65be27845400 82 */
AnnaBridge 172:65be27845400 83 #define IWDG_PRESCALER_4 0x00000000u /*!< IWDG prescaler set to 4 */
AnnaBridge 172:65be27845400 84 #define IWDG_PRESCALER_8 IWDG_PR_PR_0 /*!< IWDG prescaler set to 8 */
AnnaBridge 172:65be27845400 85 #define IWDG_PRESCALER_16 IWDG_PR_PR_1 /*!< IWDG prescaler set to 16 */
AnnaBridge 172:65be27845400 86 #define IWDG_PRESCALER_32 (IWDG_PR_PR_1 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 32 */
AnnaBridge 172:65be27845400 87 #define IWDG_PRESCALER_64 IWDG_PR_PR_2 /*!< IWDG prescaler set to 64 */
AnnaBridge 172:65be27845400 88 #define IWDG_PRESCALER_128 (IWDG_PR_PR_2 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 128 */
AnnaBridge 172:65be27845400 89 #define IWDG_PRESCALER_256 (IWDG_PR_PR_2 | IWDG_PR_PR_1) /*!< IWDG prescaler set to 256 */
AnnaBridge 172:65be27845400 90
AnnaBridge 172:65be27845400 91 /**
AnnaBridge 172:65be27845400 92 * @}
AnnaBridge 172:65be27845400 93 */
AnnaBridge 172:65be27845400 94
AnnaBridge 172:65be27845400 95 /** @defgroup IWDG_Window_option IWDG Window option
AnnaBridge 172:65be27845400 96 * @{
AnnaBridge 172:65be27845400 97 */
AnnaBridge 172:65be27845400 98 #define IWDG_WINDOW_DISABLE IWDG_WINR_WIN
AnnaBridge 172:65be27845400 99 /**
AnnaBridge 172:65be27845400 100 * @}
AnnaBridge 172:65be27845400 101 */
AnnaBridge 172:65be27845400 102
AnnaBridge 172:65be27845400 103
AnnaBridge 172:65be27845400 104 /**
AnnaBridge 172:65be27845400 105 * @}
AnnaBridge 172:65be27845400 106 */
AnnaBridge 172:65be27845400 107
AnnaBridge 172:65be27845400 108 /* Exported macros -----------------------------------------------------------*/
AnnaBridge 172:65be27845400 109 /** @defgroup IWDG_Exported_Macros IWDG Exported Macros
AnnaBridge 172:65be27845400 110 * @{
AnnaBridge 172:65be27845400 111 */
AnnaBridge 172:65be27845400 112
AnnaBridge 172:65be27845400 113 /**
AnnaBridge 172:65be27845400 114 * @brief Enable the IWDG peripheral.
AnnaBridge 172:65be27845400 115 * @param __HANDLE__ IWDG handle
AnnaBridge 172:65be27845400 116 * @retval None
AnnaBridge 172:65be27845400 117 */
AnnaBridge 172:65be27845400 118 #define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_ENABLE)
AnnaBridge 172:65be27845400 119
AnnaBridge 172:65be27845400 120 /**
AnnaBridge 172:65be27845400 121 * @brief Reload IWDG counter with value defined in the reload register
AnnaBridge 172:65be27845400 122 * (write access to IWDG_PR, IWDG_RLR & IWDG_WINR registers disabled).
AnnaBridge 172:65be27845400 123 * @param __HANDLE__ IWDG handle
AnnaBridge 172:65be27845400 124 * @retval None
AnnaBridge 172:65be27845400 125 */
AnnaBridge 172:65be27845400 126 #define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_RELOAD)
AnnaBridge 172:65be27845400 127
AnnaBridge 172:65be27845400 128 /**
AnnaBridge 172:65be27845400 129 * @}
AnnaBridge 172:65be27845400 130 */
AnnaBridge 172:65be27845400 131
AnnaBridge 172:65be27845400 132 /* Exported functions --------------------------------------------------------*/
AnnaBridge 172:65be27845400 133 /** @defgroup IWDG_Exported_Functions IWDG Exported Functions
AnnaBridge 172:65be27845400 134 * @{
AnnaBridge 172:65be27845400 135 */
AnnaBridge 172:65be27845400 136
AnnaBridge 172:65be27845400 137 /** @defgroup IWDG_Exported_Functions_Group1 Initialization and Start functions
AnnaBridge 172:65be27845400 138 * @{
AnnaBridge 172:65be27845400 139 */
AnnaBridge 172:65be27845400 140 /* Initialization/Start functions ********************************************/
AnnaBridge 172:65be27845400 141 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
AnnaBridge 172:65be27845400 142 /**
AnnaBridge 172:65be27845400 143 * @}
AnnaBridge 172:65be27845400 144 */
AnnaBridge 172:65be27845400 145
AnnaBridge 172:65be27845400 146 /** @defgroup IWDG_Exported_Functions_Group2 IO operation functions
AnnaBridge 172:65be27845400 147 * @{
AnnaBridge 172:65be27845400 148 */
AnnaBridge 172:65be27845400 149 /* I/O operation functions ****************************************************/
AnnaBridge 172:65be27845400 150 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
AnnaBridge 172:65be27845400 151 /**
AnnaBridge 172:65be27845400 152 * @}
AnnaBridge 172:65be27845400 153 */
AnnaBridge 172:65be27845400 154
AnnaBridge 172:65be27845400 155 /**
AnnaBridge 172:65be27845400 156 * @}
AnnaBridge 172:65be27845400 157 */
AnnaBridge 172:65be27845400 158
AnnaBridge 172:65be27845400 159 /* Private constants ---------------------------------------------------------*/
AnnaBridge 172:65be27845400 160 /** @defgroup IWDG_Private_Constants IWDG Private Constants
AnnaBridge 172:65be27845400 161 * @{
AnnaBridge 172:65be27845400 162 */
AnnaBridge 172:65be27845400 163
AnnaBridge 172:65be27845400 164 /**
AnnaBridge 172:65be27845400 165 * @brief IWDG Key Register BitMask
AnnaBridge 172:65be27845400 166 */
AnnaBridge 172:65be27845400 167 #define IWDG_KEY_RELOAD 0x0000AAAAu /*!< IWDG Reload Counter Enable */
AnnaBridge 172:65be27845400 168 #define IWDG_KEY_ENABLE 0x0000CCCCu /*!< IWDG Peripheral Enable */
AnnaBridge 172:65be27845400 169 #define IWDG_KEY_WRITE_ACCESS_ENABLE 0x00005555u /*!< IWDG KR Write Access Enable */
AnnaBridge 172:65be27845400 170 #define IWDG_KEY_WRITE_ACCESS_DISABLE 0x00000000u /*!< IWDG KR Write Access Disable */
AnnaBridge 172:65be27845400 171
AnnaBridge 172:65be27845400 172 /**
AnnaBridge 172:65be27845400 173 * @}
AnnaBridge 172:65be27845400 174 */
AnnaBridge 172:65be27845400 175
AnnaBridge 172:65be27845400 176 /* Private macros ------------------------------------------------------------*/
AnnaBridge 172:65be27845400 177 /** @defgroup IWDG_Private_Macros IWDG Private Macros
AnnaBridge 172:65be27845400 178 * @{
AnnaBridge 172:65be27845400 179 */
AnnaBridge 172:65be27845400 180
AnnaBridge 172:65be27845400 181 /**
AnnaBridge 172:65be27845400 182 * @brief Enable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers.
AnnaBridge 172:65be27845400 183 * @param __HANDLE__ IWDG handle
AnnaBridge 172:65be27845400 184 * @retval None
AnnaBridge 172:65be27845400 185 */
AnnaBridge 172:65be27845400 186 #define IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_ENABLE)
AnnaBridge 172:65be27845400 187
AnnaBridge 172:65be27845400 188 /**
AnnaBridge 172:65be27845400 189 * @brief Disable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers.
AnnaBridge 172:65be27845400 190 * @param __HANDLE__ IWDG handle
AnnaBridge 172:65be27845400 191 * @retval None
AnnaBridge 172:65be27845400 192 */
AnnaBridge 172:65be27845400 193 #define IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_DISABLE)
AnnaBridge 172:65be27845400 194
AnnaBridge 172:65be27845400 195 /**
AnnaBridge 172:65be27845400 196 * @brief Check IWDG prescaler value.
AnnaBridge 172:65be27845400 197 * @param __PRESCALER__ IWDG prescaler value
AnnaBridge 172:65be27845400 198 * @retval None
AnnaBridge 172:65be27845400 199 */
AnnaBridge 172:65be27845400 200 #define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4) || \
AnnaBridge 172:65be27845400 201 ((__PRESCALER__) == IWDG_PRESCALER_8) || \
AnnaBridge 172:65be27845400 202 ((__PRESCALER__) == IWDG_PRESCALER_16) || \
AnnaBridge 172:65be27845400 203 ((__PRESCALER__) == IWDG_PRESCALER_32) || \
AnnaBridge 172:65be27845400 204 ((__PRESCALER__) == IWDG_PRESCALER_64) || \
AnnaBridge 172:65be27845400 205 ((__PRESCALER__) == IWDG_PRESCALER_128)|| \
AnnaBridge 172:65be27845400 206 ((__PRESCALER__) == IWDG_PRESCALER_256))
AnnaBridge 172:65be27845400 207
AnnaBridge 172:65be27845400 208 /**
AnnaBridge 172:65be27845400 209 * @brief Check IWDG reload value.
AnnaBridge 172:65be27845400 210 * @param __RELOAD__ IWDG reload value
AnnaBridge 172:65be27845400 211 * @retval None
AnnaBridge 172:65be27845400 212 */
AnnaBridge 172:65be27845400 213 #define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= IWDG_RLR_RL)
AnnaBridge 172:65be27845400 214
AnnaBridge 172:65be27845400 215 /**
AnnaBridge 172:65be27845400 216 * @brief Check IWDG window value.
AnnaBridge 172:65be27845400 217 * @param __WINDOW__ IWDG window value
AnnaBridge 172:65be27845400 218 * @retval None
AnnaBridge 172:65be27845400 219 */
AnnaBridge 172:65be27845400 220 #define IS_IWDG_WINDOW(__WINDOW__) ((__WINDOW__) <= IWDG_WINR_WIN)
AnnaBridge 172:65be27845400 221
AnnaBridge 172:65be27845400 222 /**
AnnaBridge 172:65be27845400 223 * @}
AnnaBridge 172:65be27845400 224 */
AnnaBridge 172:65be27845400 225
AnnaBridge 172:65be27845400 226 /**
AnnaBridge 172:65be27845400 227 * @}
AnnaBridge 172:65be27845400 228 */
AnnaBridge 172:65be27845400 229
AnnaBridge 172:65be27845400 230 /**
AnnaBridge 172:65be27845400 231 * @}
AnnaBridge 172:65be27845400 232 */
AnnaBridge 172:65be27845400 233
AnnaBridge 172:65be27845400 234
AnnaBridge 172:65be27845400 235 #ifdef __cplusplus
AnnaBridge 172:65be27845400 236 }
AnnaBridge 172:65be27845400 237 #endif
AnnaBridge 172:65be27845400 238
AnnaBridge 172:65be27845400 239 #endif /* STM32H7xx_HAL_IWDG_H */
AnnaBridge 172:65be27845400 240
AnnaBridge 172:65be27845400 241 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/