tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_iwdg.h

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