mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Last commit 20 Feb 2019 by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_iwdg.h@613:bc40b8d2aec4, 2015-08-20 (annotated)

Committer:
mbed_official
Date:
Thu Aug 20 10:45:13 2015 +0100
Revision:
613:bc40b8d2aec4
Parent:
532:fe11edbda85c 
Synchronized with git revision 92ca8c7b60a283b6bb60eb65b183dac1599f0ade



Full URL: https://github.com/mbedmicro/mbed/commit/92ca8c7b60a283b6bb60eb65b183dac1599f0ade/



Nordic: update application start address in GCC linker script

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 87:085cde657901 1 /**
mbed_official 87:085cde657901 2 ******************************************************************************
mbed_official 87:085cde657901 3 * @file stm32f4xx_hal_iwdg.h
mbed_official 87:085cde657901 4 * @author MCD Application Team
mbed_official 613:bc40b8d2aec4 5 * @version V1.3.2
mbed_official 613:bc40b8d2aec4 6 * @date 26-June-2015
mbed_official 87:085cde657901 7 * @brief Header file of IWDG HAL module.
mbed_official 87:085cde657901 8 ******************************************************************************
mbed_official 87:085cde657901 9 * @attention
mbed_official 87:085cde657901 10 *
mbed_official 532:fe11edbda85c 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
mbed_official 87:085cde657901 12 *
mbed_official 87:085cde657901 13 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 87:085cde657901 14 * are permitted provided that the following conditions are met:
mbed_official 87:085cde657901 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 87:085cde657901 16 * this list of conditions and the following disclaimer.
mbed_official 87:085cde657901 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 87:085cde657901 18 * this list of conditions and the following disclaimer in the documentation
mbed_official 87:085cde657901 19 * and/or other materials provided with the distribution.
mbed_official 87:085cde657901 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 87:085cde657901 21 * may be used to endorse or promote products derived from this software
mbed_official 87:085cde657901 22 * without specific prior written permission.
mbed_official 87:085cde657901 23 *
mbed_official 87:085cde657901 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 87:085cde657901 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 87:085cde657901 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 87:085cde657901 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 87:085cde657901 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 87:085cde657901 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 87:085cde657901 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 87:085cde657901 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 87:085cde657901 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 87:085cde657901 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 87:085cde657901 34 *
mbed_official 87:085cde657901 35 ******************************************************************************
mbed_official 87:085cde657901 36 */
mbed_official 87:085cde657901 37
mbed_official 87:085cde657901 38 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 87:085cde657901 39 #ifndef __STM32F4xx_HAL_IWDG_H
mbed_official 87:085cde657901 40 #define __STM32F4xx_HAL_IWDG_H
mbed_official 87:085cde657901 41
mbed_official 87:085cde657901 42 #ifdef __cplusplus
mbed_official 87:085cde657901 43 extern "C" {
mbed_official 87:085cde657901 44 #endif
mbed_official 87:085cde657901 45
mbed_official 87:085cde657901 46 /* Includes ------------------------------------------------------------------*/
mbed_official 87:085cde657901 47 #include "stm32f4xx_hal_def.h"
mbed_official 87:085cde657901 48
mbed_official 87:085cde657901 49 /** @addtogroup STM32F4xx_HAL_Driver
mbed_official 87:085cde657901 50 * @{
mbed_official 87:085cde657901 51 */
mbed_official 87:085cde657901 52
mbed_official 87:085cde657901 53 /** @addtogroup IWDG
mbed_official 87:085cde657901 54 * @{
mbed_official 87:085cde657901 55 */
mbed_official 87:085cde657901 56
mbed_official 106:ced8cbb51063 57 /* Exported types ------------------------------------------------------------*/
mbed_official 532:fe11edbda85c 58 /** @defgroup IWDG_Exported_Types IWDG Exported Types
mbed_official 532:fe11edbda85c 59 * @{
mbed_official 532:fe11edbda85c 60 */
mbed_official 532:fe11edbda85c 61
mbed_official 87:085cde657901 62 /**
mbed_official 87:085cde657901 63 * @brief IWDG HAL State Structure definition
mbed_official 87:085cde657901 64 */
mbed_official 87:085cde657901 65 typedef enum
mbed_official 87:085cde657901 66 {
mbed_official 87:085cde657901 67 HAL_IWDG_STATE_RESET = 0x00, /*!< IWDG not yet initialized or disabled */
mbed_official 87:085cde657901 68 HAL_IWDG_STATE_READY = 0x01, /*!< IWDG initialized and ready for use */
mbed_official 106:ced8cbb51063 69 HAL_IWDG_STATE_BUSY = 0x02, /*!< IWDG internal process is ongoing */
mbed_official 87:085cde657901 70 HAL_IWDG_STATE_TIMEOUT = 0x03, /*!< IWDG timeout state */
mbed_official 87:085cde657901 71 HAL_IWDG_STATE_ERROR = 0x04 /*!< IWDG error state */
mbed_official 87:085cde657901 72 }HAL_IWDG_StateTypeDef;
mbed_official 87:085cde657901 73
mbed_official 87:085cde657901 74 /**
mbed_official 87:085cde657901 75 * @brief IWDG Init structure definition
mbed_official 87:085cde657901 76 */
mbed_official 87:085cde657901 77 typedef struct
mbed_official 87:085cde657901 78 {
mbed_official 87:085cde657901 79 uint32_t Prescaler; /*!< Select the prescaler of the IWDG.
mbed_official 87:085cde657901 80 This parameter can be a value of @ref IWDG_Prescaler */
mbed_official 87:085cde657901 81
mbed_official 87:085cde657901 82 uint32_t Reload; /*!< Specifies the IWDG down-counter reload value.
mbed_official 106:ced8cbb51063 83 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
mbed_official 87:085cde657901 84 }IWDG_InitTypeDef;
mbed_official 87:085cde657901 85
mbed_official 87:085cde657901 86 /**
mbed_official 532:fe11edbda85c 87 * @brief IWDG Handle Structure definition
mbed_official 87:085cde657901 88 */
mbed_official 87:085cde657901 89 typedef struct
mbed_official 87:085cde657901 90 {
mbed_official 87:085cde657901 91 IWDG_TypeDef *Instance; /*!< Register base address */
mbed_official 87:085cde657901 92
mbed_official 87:085cde657901 93 IWDG_InitTypeDef Init; /*!< IWDG required parameters */
mbed_official 87:085cde657901 94
mbed_official 532:fe11edbda85c 95 HAL_LockTypeDef Lock; /*!< IWDG Locking object */
mbed_official 87:085cde657901 96
mbed_official 87:085cde657901 97 __IO HAL_IWDG_StateTypeDef State; /*!< IWDG communication state */
mbed_official 87:085cde657901 98 }IWDG_HandleTypeDef;
mbed_official 87:085cde657901 99
mbed_official 87:085cde657901 100 /**
mbed_official 87:085cde657901 101 * @}
mbed_official 87:085cde657901 102 */
mbed_official 87:085cde657901 103
mbed_official 532:fe11edbda85c 104 /* Exported constants --------------------------------------------------------*/
mbed_official 532:fe11edbda85c 105 /** @defgroup IWDG_Exported_Constants IWDG Exported Constants
mbed_official 532:fe11edbda85c 106 * @{
mbed_official 532:fe11edbda85c 107 */
mbed_official 532:fe11edbda85c 108
mbed_official 532:fe11edbda85c 109 /** @defgroup IWDG_Registers_BitMask IWDG Registers BitMask
mbed_official 532:fe11edbda85c 110 * @brief IWDG registers bit mask
mbed_official 532:fe11edbda85c 111 * @{
mbed_official 532:fe11edbda85c 112 */
mbed_official 532:fe11edbda85c 113 /* --- KR Register ---*/
mbed_official 532:fe11edbda85c 114 /* KR register bit mask */
mbed_official 532:fe11edbda85c 115 #define IWDG_KEY_RELOAD ((uint32_t)0xAAAA) /*!< IWDG Reload Counter Enable */
mbed_official 532:fe11edbda85c 116 #define IWDG_KEY_ENABLE ((uint32_t)0xCCCC) /*!< IWDG Peripheral Enable */
mbed_official 532:fe11edbda85c 117 #define IWDG_KEY_WRITE_ACCESS_ENABLE ((uint32_t)0x5555) /*!< IWDG KR Write Access Enable */
mbed_official 532:fe11edbda85c 118 #define IWDG_KEY_WRITE_ACCESS_DISABLE ((uint32_t)0x0000) /*!< IWDG KR Write Access Disable */
mbed_official 532:fe11edbda85c 119 /**
mbed_official 532:fe11edbda85c 120 * @}
mbed_official 532:fe11edbda85c 121 */
mbed_official 532:fe11edbda85c 122
mbed_official 532:fe11edbda85c 123 /** @defgroup IWDG_Flag_definition IWDG Flag definition
mbed_official 532:fe11edbda85c 124 * @{
mbed_official 532:fe11edbda85c 125 */
mbed_official 532:fe11edbda85c 126 #define IWDG_FLAG_PVU ((uint32_t)IWDG_SR_PVU) /*!< Watchdog counter prescaler value update Flag */
mbed_official 532:fe11edbda85c 127 #define IWDG_FLAG_RVU ((uint32_t)IWDG_SR_RVU) /*!< Watchdog counter reload value update Flag */
mbed_official 532:fe11edbda85c 128 /**
mbed_official 532:fe11edbda85c 129 * @}
mbed_official 532:fe11edbda85c 130 */
mbed_official 532:fe11edbda85c 131
mbed_official 532:fe11edbda85c 132 /** @defgroup IWDG_Prescaler IWDG Prescaler
mbed_official 87:085cde657901 133 * @{
mbed_official 87:085cde657901 134 */
mbed_official 87:085cde657901 135 #define IWDG_PRESCALER_4 ((uint8_t)0x00) /*!< IWDG prescaler set to 4 */
mbed_official 369:2e96f1b71984 136 #define IWDG_PRESCALER_8 ((uint8_t)(IWDG_PR_PR_0)) /*!< IWDG prescaler set to 8 */
mbed_official 369:2e96f1b71984 137 #define IWDG_PRESCALER_16 ((uint8_t)(IWDG_PR_PR_1)) /*!< IWDG prescaler set to 16 */
mbed_official 369:2e96f1b71984 138 #define IWDG_PRESCALER_32 ((uint8_t)(IWDG_PR_PR_1 | IWDG_PR_PR_0)) /*!< IWDG prescaler set to 32 */
mbed_official 369:2e96f1b71984 139 #define IWDG_PRESCALER_64 ((uint8_t)(IWDG_PR_PR_2)) /*!< IWDG prescaler set to 64 */
mbed_official 369:2e96f1b71984 140 #define IWDG_PRESCALER_128 ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_0)) /*!< IWDG prescaler set to 128 */
mbed_official 369:2e96f1b71984 141 #define IWDG_PRESCALER_256 ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_1)) /*!< IWDG prescaler set to 256 */
mbed_official 87:085cde657901 142 /**
mbed_official 87:085cde657901 143 * @}
mbed_official 87:085cde657901 144 */
mbed_official 87:085cde657901 145
mbed_official 87:085cde657901 146 /**
mbed_official 87:085cde657901 147 * @}
mbed_official 87:085cde657901 148 */
mbed_official 87:085cde657901 149
mbed_official 532:fe11edbda85c 150 /* Exported macros -----------------------------------------------------------*/
mbed_official 532:fe11edbda85c 151 /** @defgroup IWDG_Exported_Macros IWDG Exported Macros
mbed_official 532:fe11edbda85c 152 * @{
mbed_official 532:fe11edbda85c 153 */
mbed_official 87:085cde657901 154
mbed_official 226:b062af740e40 155 /** @brief Reset IWDG handle state
mbed_official 532:fe11edbda85c 156 * @param __HANDLE__: IWDG handle.
mbed_official 226:b062af740e40 157 * @retval None
mbed_official 226:b062af740e40 158 */
mbed_official 226:b062af740e40 159 #define __HAL_IWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IWDG_STATE_RESET)
mbed_official 226:b062af740e40 160
mbed_official 87:085cde657901 161 /**
mbed_official 87:085cde657901 162 * @brief Enables the IWDG peripheral.
mbed_official 87:085cde657901 163 * @param __HANDLE__: IWDG handle
mbed_official 87:085cde657901 164 * @retval None
mbed_official 87:085cde657901 165 */
mbed_official 532:fe11edbda85c 166 #define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_ENABLE)
mbed_official 87:085cde657901 167
mbed_official 87:085cde657901 168 /**
mbed_official 87:085cde657901 169 * @brief Reloads IWDG counter with value defined in the reload register
mbed_official 87:085cde657901 170 * (write access to IWDG_PR and IWDG_RLR registers disabled).
mbed_official 87:085cde657901 171 * @param __HANDLE__: IWDG handle
mbed_official 87:085cde657901 172 * @retval None
mbed_official 87:085cde657901 173 */
mbed_official 532:fe11edbda85c 174 #define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_RELOAD)
mbed_official 87:085cde657901 175
mbed_official 87:085cde657901 176 /**
mbed_official 87:085cde657901 177 * @brief Gets the selected IWDG's flag status.
mbed_official 87:085cde657901 178 * @param __HANDLE__: IWDG handle
mbed_official 87:085cde657901 179 * @param __FLAG__: specifies the flag to check.
mbed_official 87:085cde657901 180 * This parameter can be one of the following values:
mbed_official 87:085cde657901 181 * @arg IWDG_FLAG_PVU: Watchdog counter reload value update flag
mbed_official 87:085cde657901 182 * @arg IWDG_FLAG_RVU: Watchdog counter prescaler value flag
mbed_official 87:085cde657901 183 * @retval The new state of __FLAG__ (TRUE or FALSE).
mbed_official 87:085cde657901 184 */
mbed_official 87:085cde657901 185 #define __HAL_IWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
mbed_official 87:085cde657901 186
mbed_official 532:fe11edbda85c 187 /**
mbed_official 532:fe11edbda85c 188 * @}
mbed_official 532:fe11edbda85c 189 */
mbed_official 532:fe11edbda85c 190
mbed_official 87:085cde657901 191 /* Exported functions --------------------------------------------------------*/
mbed_official 532:fe11edbda85c 192 /** @addtogroup IWDG_Exported_Functions
mbed_official 532:fe11edbda85c 193 * @{
mbed_official 532:fe11edbda85c 194 */
mbed_official 87:085cde657901 195
mbed_official 532:fe11edbda85c 196 /** @addtogroup IWDG_Exported_Functions_Group1
mbed_official 532:fe11edbda85c 197 * @{
mbed_official 532:fe11edbda85c 198 */
mbed_official 106:ced8cbb51063 199 /* Initialization/de-initialization functions ********************************/
mbed_official 87:085cde657901 200 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
mbed_official 106:ced8cbb51063 201 void HAL_IWDG_MspInit(IWDG_HandleTypeDef *hiwdg);
mbed_official 532:fe11edbda85c 202 /**
mbed_official 532:fe11edbda85c 203 * @}
mbed_official 532:fe11edbda85c 204 */
mbed_official 87:085cde657901 205
mbed_official 532:fe11edbda85c 206 /** @addtogroup IWDG_Exported_Functions_Group2
mbed_official 532:fe11edbda85c 207 * @{
mbed_official 532:fe11edbda85c 208 */
mbed_official 106:ced8cbb51063 209 /* I/O operation functions ****************************************************/
mbed_official 87:085cde657901 210 HAL_StatusTypeDef HAL_IWDG_Start(IWDG_HandleTypeDef *hiwdg);
mbed_official 87:085cde657901 211 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
mbed_official 532:fe11edbda85c 212 /**
mbed_official 532:fe11edbda85c 213 * @}
mbed_official 532:fe11edbda85c 214 */
mbed_official 87:085cde657901 215
mbed_official 532:fe11edbda85c 216 /** @addtogroup IWDG_Exported_Functions_Group3
mbed_official 532:fe11edbda85c 217 * @{
mbed_official 532:fe11edbda85c 218 */
mbed_official 106:ced8cbb51063 219 /* Peripheral State functions ************************************************/
mbed_official 87:085cde657901 220 HAL_IWDG_StateTypeDef HAL_IWDG_GetState(IWDG_HandleTypeDef *hiwdg);
mbed_official 87:085cde657901 221
mbed_official 87:085cde657901 222 /**
mbed_official 87:085cde657901 223 * @}
mbed_official 532:fe11edbda85c 224 */
mbed_official 532:fe11edbda85c 225
mbed_official 532:fe11edbda85c 226 /**
mbed_official 532:fe11edbda85c 227 * @}
mbed_official 532:fe11edbda85c 228 */
mbed_official 532:fe11edbda85c 229
mbed_official 532:fe11edbda85c 230 /* Private macro -------------------------------------------------------------*/
mbed_official 532:fe11edbda85c 231 /** @defgroup IWDG_Private_Macros IWDG Private Macros
mbed_official 532:fe11edbda85c 232 * @{
mbed_official 532:fe11edbda85c 233 */
mbed_official 532:fe11edbda85c 234
mbed_official 532:fe11edbda85c 235 /**
mbed_official 532:fe11edbda85c 236 * @brief Enables write access to IWDG_PR and IWDG_RLR registers.
mbed_official 532:fe11edbda85c 237 * @param __HANDLE__: IWDG handle
mbed_official 532:fe11edbda85c 238 * @retval None
mbed_official 532:fe11edbda85c 239 */
mbed_official 532:fe11edbda85c 240 #define IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_ENABLE)
mbed_official 532:fe11edbda85c 241
mbed_official 532:fe11edbda85c 242 /**
mbed_official 532:fe11edbda85c 243 * @brief Disables write access to IWDG_PR and IWDG_RLR registers.
mbed_official 532:fe11edbda85c 244 * @param __HANDLE__: IWDG handle
mbed_official 532:fe11edbda85c 245 * @retval None
mbed_official 532:fe11edbda85c 246 */
mbed_official 532:fe11edbda85c 247 #define IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_DISABLE)
mbed_official 532:fe11edbda85c 248
mbed_official 532:fe11edbda85c 249
mbed_official 532:fe11edbda85c 250 #define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4) || \
mbed_official 532:fe11edbda85c 251 ((__PRESCALER__) == IWDG_PRESCALER_8) || \
mbed_official 532:fe11edbda85c 252 ((__PRESCALER__) == IWDG_PRESCALER_16) || \
mbed_official 532:fe11edbda85c 253 ((__PRESCALER__) == IWDG_PRESCALER_32) || \
mbed_official 532:fe11edbda85c 254 ((__PRESCALER__) == IWDG_PRESCALER_64) || \
mbed_official 532:fe11edbda85c 255 ((__PRESCALER__) == IWDG_PRESCALER_128)|| \
mbed_official 532:fe11edbda85c 256 ((__PRESCALER__) == IWDG_PRESCALER_256))
mbed_official 532:fe11edbda85c 257
mbed_official 532:fe11edbda85c 258
mbed_official 532:fe11edbda85c 259 #define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= 0xFFF)
mbed_official 532:fe11edbda85c 260
mbed_official 532:fe11edbda85c 261 /**
mbed_official 532:fe11edbda85c 262 * @}
mbed_official 532:fe11edbda85c 263 */
mbed_official 532:fe11edbda85c 264
mbed_official 532:fe11edbda85c 265 /* Private define ------------------------------------------------------------*/
mbed_official 532:fe11edbda85c 266 /** @defgroup IWDG_Private_Constants IWDG Private Constants
mbed_official 532:fe11edbda85c 267 * @{
mbed_official 532:fe11edbda85c 268 */
mbed_official 532:fe11edbda85c 269
mbed_official 532:fe11edbda85c 270 /**
mbed_official 532:fe11edbda85c 271 * @}
mbed_official 532:fe11edbda85c 272 */
mbed_official 532:fe11edbda85c 273
mbed_official 532:fe11edbda85c 274 /**
mbed_official 532:fe11edbda85c 275 * @}
mbed_official 87:085cde657901 276 */
mbed_official 87:085cde657901 277
mbed_official 87:085cde657901 278 /**
mbed_official 87:085cde657901 279 * @}
mbed_official 87:085cde657901 280 */
mbed_official 87:085cde657901 281
mbed_official 87:085cde657901 282 #ifdef __cplusplus
mbed_official 87:085cde657901 283 }
mbed_official 87:085cde657901 284 #endif
mbed_official 87:085cde657901 285
mbed_official 87:085cde657901 286 #endif /* __STM32F4xx_HAL_IWDG_H */
mbed_official 87:085cde657901 287
mbed_official 87:085cde657901 288 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/