ON Semiconductor / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

targets/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_iwdg.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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