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_L496ZG_P/TOOLCHAIN_GCC_ARM/stm32l4xx_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_L475VG_IOT01A/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_iwdg.h@161:aa5281ff4a02 
mbed library. Release version 164

Who changed what in which revision?

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