Thomas Lyp / DevLibMemoryController

Initial commit

Dependencies:   FastPWM

mbed-dev-master/targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_iwdg.h@0:bb348c97df44, 2020-09-16 (annotated)

Committer:
lypinator
Date:
Wed Sep 16 01:11:49 2020 +0000
Revision:
0:bb348c97df44
Added PWM

Who changed what in which revision?

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