mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_iwdg.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

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