lib/main/STM32F4/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_iwdg.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_iwdg.h
   4   * @author  MCD Application Team
   5   * @version V1.7.1
   6   * @date    14-April-2017
   7   * @brief   Header file of IWDG HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2017 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 __STM32F4xx_HAL_IWDG_H
  40 #define __STM32F4xx_HAL_IWDG_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f4xx_hal_def.h"
  48
  49 /** @addtogroup STM32F4xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup IWDG
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /** @defgroup IWDG_Exported_Types IWDG Exported Types
  59   * @{
  60   */
  61
  62 /**
  63   * @brief  IWDG Init structure definition
  64   */
  65 typedef struct
  66 {
  67   uint32_t Prescaler;  /*!< Select the prescaler of the IWDG.
  68                             This parameter can be a value of @ref IWDG_Prescaler */
  69
  70   uint32_t Reload;     /*!< Specifies the IWDG down-counter reload value.
  71                             This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
  72
  73 } IWDG_InitTypeDef;
  74
  75 /**
  76   * @brief  IWDG Handle Structure definition
  77   */
  78 typedef struct
  79 {
  80   IWDG_TypeDef                 *Instance;  /*!< Register base address    */
  81
  82   IWDG_InitTypeDef             Init;       /*!< IWDG required parameters */
  83
  84 }IWDG_HandleTypeDef;
  85
  86 /**
  87   * @}
  88   */
  89
  90 /* Exported constants --------------------------------------------------------*/
  91 /** @defgroup IWDG_Exported_Constants IWDG Exported Constants
  92   * @{
  93   */
  94
  95 /** @defgroup IWDG_Prescaler IWDG Prescaler
  96   * @{
  97   */
  98 #define IWDG_PRESCALER_4                0x00000000U                   /*!< IWDG prescaler set to 4   */
  99 #define IWDG_PRESCALER_8                IWDG_PR_PR_0                  /*!< IWDG prescaler set to 8   */
 100 #define IWDG_PRESCALER_16               IWDG_PR_PR_1                  /*!< IWDG prescaler set to 16  */
 101 #define IWDG_PRESCALER_32               (IWDG_PR_PR_1 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 32  */
 102 #define IWDG_PRESCALER_64               IWDG_PR_PR_2                  /*!< IWDG prescaler set to 64  */
 103 #define IWDG_PRESCALER_128              (IWDG_PR_PR_2 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 128 */
 104 #define IWDG_PRESCALER_256              (IWDG_PR_PR_2 | IWDG_PR_PR_1) /*!< IWDG prescaler set to 256 */
 105 /**
 106   * @}
 107   */
 108
 109 /**
 110   * @}
 111   */
 112
 113 /* Exported macros -----------------------------------------------------------*/
 114 /** @defgroup IWDG_Exported_Macros IWDG Exported Macros
 115   * @{
 116   */
 117
 118 /**
 119   * @brief  Enable the IWDG peripheral.
 120   * @param  __HANDLE__  IWDG handle
 121   * @retval None
 122   */
 123 #define __HAL_IWDG_START(__HANDLE__)                WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_ENABLE)
 124
 125 /**
 126   * @brief  Reload IWDG counter with value defined in the reload register
 127   *         (write access to IWDG_PR & IWDG_RLR registers disabled).
 128   * @param  __HANDLE__  IWDG handle
 129   * @retval None
 130   */
 131 #define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__)       WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_RELOAD)
 132
 133 /**
 134   * @}
 135   */
 136
 137 /* Exported functions --------------------------------------------------------*/
 138 /** @defgroup IWDG_Exported_Functions  IWDG Exported Functions
 139   * @{
 140   */
 141
 142 /** @defgroup IWDG_Exported_Functions_Group1 Initialization and Start functions
 143   * @{
 144   */
 145 /* Initialization/Start functions  ********************************************/
 146 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
 147 /**
 148   * @}
 149   */
 150
 151 /** @defgroup IWDG_Exported_Functions_Group2 IO operation functions
 152   * @{
 153   */
 154 /* I/O operation functions ****************************************************/
 155 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
 156 /**
 157   * @}
 158   */
 159
 160 /**
 161   * @}
 162   */
 163
 164 /* Private constants ---------------------------------------------------------*/
 165 /** @defgroup IWDG_Private_Constants IWDG Private Constants
 166   * @{
 167   */
 168
 169 /**
 170   * @brief  IWDG Key Register BitMask
 171   */
 172 #define IWDG_KEY_RELOAD                 0x0000AAAAU  /*!< IWDG Reload Counter Enable   */
 173 #define IWDG_KEY_ENABLE                 0x0000CCCCU  /*!< IWDG Peripheral Enable       */
 174 #define IWDG_KEY_WRITE_ACCESS_ENABLE    0x00005555U  /*!< IWDG KR Write Access Enable  */
 175 #define IWDG_KEY_WRITE_ACCESS_DISABLE   0x00000000U  /*!< IWDG KR Write Access Disable */
 176
 177 /**
 178   * @}
 179   */
 180
 181 /* Private macros ------------------------------------------------------------*/
 182 /** @defgroup IWDG_Private_Macros IWDG Private Macros
 183   * @{
 184   */
 185
 186 /**
 187   * @brief  Enable write access to IWDG_PR and IWDG_RLR registers.
 188   * @param  __HANDLE__  IWDG handle
 189   * @retval None
 190   */
 191 #define IWDG_ENABLE_WRITE_ACCESS(__HANDLE__)  WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_ENABLE)
 192
 193 /**
 194   * @brief  Disable write access to IWDG_PR and IWDG_RLR registers.
 195   * @param  __HANDLE__  IWDG handle
 196   * @retval None
 197   */
 198 #define IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_DISABLE)
 199
 200 /**
 201   * @brief  Check IWDG prescaler value.
 202   * @param  __PRESCALER__  IWDG prescaler value
 203   * @retval None
 204   */
 205 #define IS_IWDG_PRESCALER(__PRESCALER__)      (((__PRESCALER__) == IWDG_PRESCALER_4)  || \
 206                                                ((__PRESCALER__) == IWDG_PRESCALER_8)  || \
 207                                                ((__PRESCALER__) == IWDG_PRESCALER_16) || \
 208                                                ((__PRESCALER__) == IWDG_PRESCALER_32) || \
 209                                                ((__PRESCALER__) == IWDG_PRESCALER_64) || \
 210                                                ((__PRESCALER__) == IWDG_PRESCALER_128)|| \
 211                                                ((__PRESCALER__) == IWDG_PRESCALER_256))
 212
 213 /**
 214   * @brief  Check IWDG reload value.
 215   * @param  __RELOAD__  IWDG reload value
 216   * @retval None
 217   */
 218 #define IS_IWDG_RELOAD(__RELOAD__)            ((__RELOAD__) <= IWDG_RLR_RL)
 219
 220 /**
 221   * @}
 222   */
 223
 224 /**
 225   * @}
 226   */
 227
 228 /**
 229   * @}
 230   */
 231
 232
 233 #ifdef __cplusplus
 234 }
 235 #endif
 236
 237 #endif /* __STM32F4xx_HAL_IWDG_H */
 238
 239 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/