雄介 太田 / mbed

mbed(SerialHalfDuplex入り)

Fork of mbed by mbed official

TARGET_MTS_MDOT_F411RE/stm32f4xx_hal_iwdg.h@98:01a414ca7d6d, 2015-04-08 (annotated)

Committer:
yusuke_kyo
Date:
Wed Apr 08 08:04:18 2015 +0000
Revision:
98:01a414ca7d6d
Parent:
93:e188a91d3eaa 
remove SerialHalfDuplex.h

Who changed what in which revision?

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