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