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_F303RE/TOOLCHAIN_ARM_MICRO/stm32f3xx_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_DISCO_F303VC/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_iwdg.h@168:b9e159c1930a 
mbed library. Release version 164

Who changed what in which revision?

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