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_L011K4/TOOLCHAIN_ARM_MICRO/stm32l0xx_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_L072CZ_LRWAN1/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_iwdg.h@167:84c0a372a020 
mbed library. Release version 164

Who changed what in which revision?

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