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_F412ZG/TOOLCHAIN_IAR/stm32f4xx_hal_iwdg.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_WIO_3G/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_iwdg.h@169:a7c7b631e539 
mbed library. Release version 164

Who changed what in which revision?

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