Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_iwdg.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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