git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_STM32F7_STM32756G-EVAL/ST_Library/include/stm32f7xx_hal_wwdg.h

   1 /**\r
   2   ******************************************************************************\r
   3   * @file    stm32f7xx_hal_wwdg.h\r
   4   * @author  MCD Application Team\r
   5   * @version V0.3.0\r
   6   * @date    06-March-2015\r
   7   * @brief   Header file of WWDG HAL module.\r
   8   ******************************************************************************\r
   9   * @attention\r
  10   *\r
  11   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>\r
  12   *\r
  13   * Redistribution and use in source and binary forms, with or without modification,\r
  14   * are permitted provided that the following conditions are met:\r
  15   *   1. Redistributions of source code must retain the above copyright notice,\r
  16   *      this list of conditions and the following disclaimer.\r
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,\r
  18   *      this list of conditions and the following disclaimer in the documentation\r
  19   *      and/or other materials provided with the distribution.\r
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors\r
  21   *      may be used to endorse or promote products derived from this software\r
  22   *      without specific prior written permission.\r
  23   *\r
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\r
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\r
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\r
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\r
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\r
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  34   *\r
  35   ******************************************************************************\r
  36   */ \r
  37 \r
  38 /* Define to prevent recursive inclusion -------------------------------------*/\r
  39 #ifndef __STM32F7xx_HAL_WWDG_H\r
  40 #define __STM32F7xx_HAL_WWDG_H\r
  41 \r
  42 #ifdef __cplusplus\r
  43  extern "C" {\r
  44 #endif\r
  45 \r
  46 /* Includes ------------------------------------------------------------------*/\r
  47 #include "stm32f7xx_hal_def.h"\r
  48 \r
  49 /** @addtogroup STM32F7xx_HAL_Driver\r
  50   * @{\r
  51   */\r
  52 \r
  53 /** @addtogroup WWDG\r
  54   * @{\r
  55   */ \r
  56 \r
  57 /* Exported types ------------------------------------------------------------*/\r
  58 /** @defgroup WWDG_Exported_Types WWDG Exported Types\r
  59   * @{\r
  60   */\r
  61    \r
  62 /**\r
  63   * @brief  WWDG HAL State Structure definition\r
  64   */\r
  65 typedef enum\r
  66 {\r
  67   HAL_WWDG_STATE_RESET     = 0x00,  /*!< WWDG not yet initialized or disabled */\r
  68   HAL_WWDG_STATE_READY     = 0x01,  /*!< WWDG initialized and ready for use   */\r
  69   HAL_WWDG_STATE_BUSY      = 0x02,  /*!< WWDG internal process is ongoing     */\r
  70   HAL_WWDG_STATE_TIMEOUT   = 0x03,  /*!< WWDG timeout state                   */\r
  71   HAL_WWDG_STATE_ERROR     = 0x04   /*!< WWDG error state                     */\r
  72 }HAL_WWDG_StateTypeDef;\r
  73 \r
  74 /** \r
  75   * @brief  WWDG Init structure definition  \r
  76   */ \r
  77 typedef struct\r
  78 {\r
  79   uint32_t Prescaler;  /*!< Specifies the prescaler value of the WWDG.\r
  80                             This parameter can be a value of @ref WWDG_Prescaler */\r
  81   \r
  82   uint32_t Window;     /*!< Specifies the WWDG window value to be compared to the downcounter.\r
  83                             This parameter must be a number lower than Max_Data = 0x80 */ \r
  84   \r
  85   uint32_t Counter;    /*!< Specifies the WWDG free-running downcounter value.\r
  86                             This parameter must be a number between Min_Data = 0x40 and Max_Data = 0x7F */\r
  87 \r
  88 }WWDG_InitTypeDef;\r
  89 \r
  90 /** \r
  91   * @brief  WWDG handle Structure definition  \r
  92   */ \r
  93 typedef struct\r
  94 {\r
  95   WWDG_TypeDef                 *Instance;  /*!< Register base address    */\r
  96   \r
  97   WWDG_InitTypeDef             Init;       /*!< WWDG required parameters */\r
  98   \r
  99   HAL_LockTypeDef              Lock;       /*!< WWDG locking object      */\r
 100   \r
 101   __IO HAL_WWDG_StateTypeDef   State;      /*!< WWDG communication state */\r
 102   \r
 103 }WWDG_HandleTypeDef;\r
 104 /**\r
 105   * @}\r
 106   */ \r
 107 \r
 108 /* Exported constants --------------------------------------------------------*/\r
 109 /** @defgroup WWDG_Exported_Constants WWDG Exported Constants\r
 110   * @{\r
 111   */\r
 112 \r
 113 /** @defgroup WWDG_Interrupt_definition WWDG Interrupt definition\r
 114   * @{\r
 115   */ \r
 116 #define WWDG_IT_EWI                       WWDG_CFR_EWI  /*!< Early wakeup interrupt */\r
 117 /**\r
 118   * @}\r
 119   */\r
 120 \r
 121 /** @defgroup WWDG_Flag_definition WWDG Flag definition\r
 122   * @brief WWDG Flag definition\r
 123   * @{\r
 124   */ \r
 125 #define WWDG_FLAG_EWIF                    WWDG_SR_EWIF  /*!< Early wakeup interrupt flag */\r
 126 /**\r
 127   * @}\r
 128   */\r
 129 \r
 130 /** @defgroup WWDG_Prescaler WWDG Prescaler\r
 131   * @{\r
 132   */ \r
 133 #define WWDG_PRESCALER_1                 ((uint32_t)0x00000000)  /*!< WWDG counter clock = (PCLK1/4096)/1 */\r
 134 #define WWDG_PRESCALER_2                  WWDG_CFR_WDGTB0  /*!< WWDG counter clock = (PCLK1/4096)/2 */\r
 135 #define WWDG_PRESCALER_4                  WWDG_CFR_WDGTB1  /*!< WWDG counter clock = (PCLK1/4096)/4 */\r
 136 #define WWDG_PRESCALER_8                  WWDG_CFR_WDGTB  /*!< WWDG counter clock = (PCLK1/4096)/8 */\r
 137 /**\r
 138   * @}\r
 139   */ \r
 140 \r
 141 /**\r
 142   * @}\r
 143   */ \r
 144 \r
 145 /* Exported macro ------------------------------------------------------------*/\r
 146 /** @defgroup WWDG_Exported_Macros WWDG Exported Macros\r
 147   * @{\r
 148   */\r
 149 \r
 150 /** @brief Reset WWDG handle state\r
 151   * @param  __HANDLE__: WWDG handle\r
 152   * @retval None\r
 153   */\r
 154 #define __HAL_WWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_WWDG_STATE_RESET)\r
 155 \r
 156 /**\r
 157   * @brief  Enables the WWDG peripheral.\r
 158   * @param  __HANDLE__: WWDG handle\r
 159   * @retval None\r
 160   */\r
 161 #define __HAL_WWDG_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, WWDG_CR_WDGA)\r
 162 \r
 163 /**\r
 164   * @brief  Disables the WWDG peripheral.\r
 165   * @param  __HANDLE__: WWDG handle\r
 166   * @note   WARNING: This is a dummy macro for HAL code alignment.\r
 167   *         Once enable, WWDG Peripheral cannot be disabled except by a system reset.\r
 168   * @retval None\r
 169   */\r
 170 #define __HAL_WWDG_DISABLE(__HANDLE__)                      /* dummy  macro */\r
 171 \r
 172 /**\r
 173   * @brief  Gets the selected WWDG's it status.\r
 174   * @param  __HANDLE__: WWDG handle\r
 175   * @param  __INTERRUPT__: specifies the it to check.\r
 176   *        This parameter can be one of the following values:\r
 177   *            @arg WWDG_FLAG_EWIF: Early wakeup interrupt IT\r
 178   * @retval The new state of WWDG_FLAG (SET or RESET).\r
 179   */\r
 180 #define __HAL_WWDG_GET_IT(__HANDLE__, __INTERRUPT__)       __HAL_WWDG_GET_FLAG((__HANDLE__),(__INTERRUPT__))\r
 181 \r
 182 /** @brief  Clear the WWDG's interrupt pending bits\r
 183   *         bits to clear the selected interrupt pending bits.\r
 184   * @param  __HANDLE__: WWDG handle\r
 185   * @param  __INTERRUPT__: specifies the interrupt pending bit to clear.\r
 186   *         This parameter can be one of the following values:\r
 187   *            @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag\r
 188   */\r
 189 #define __HAL_WWDG_CLEAR_IT(__HANDLE__, __INTERRUPT__)     __HAL_WWDG_CLEAR_FLAG((__HANDLE__), (__INTERRUPT__))\r
 190 \r
 191 /**\r
 192   * @brief  Enables the WWDG early wakeup interrupt.\r
 193   * @param  __HANDLE__: WWDG handle\r
 194   * @param  __INTERRUPT__: specifies the interrupt to enable.\r
 195   *         This parameter can be one of the following values:\r
 196   *            @arg WWDG_IT_EWI: Early wakeup interrupt\r
 197   * @note   Once enabled this interrupt cannot be disabled except by a system reset.\r
 198   * @retval None\r
 199   */\r
 200 #define __HAL_WWDG_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CFR, (__INTERRUPT__))\r
 201     \r
 202 /**\r
 203   * @brief  Disables the WWDG early wakeup interrupt.\r
 204   * @param  __HANDLE__: WWDG handle\r
 205   * @param  __INTERRUPT__: specifies the interrupt to disable.\r
 206   *         This parameter can be one of the following values:\r
 207   *            @arg WWDG_IT_EWI: Early wakeup interrupt\r
 208   * @note   WARNING: This is a dummy macro for HAL code alignment. \r
 209   *         Once enabled this interrupt cannot be disabled except by a system reset.\r
 210   * @retval None\r
 211   */\r
 212 #define __HAL_WWDG_DISABLE_IT(__HANDLE__, __INTERRUPT__)                   /* dummy  macro */\r
 213     \r
 214 /**\r
 215   * @brief  Gets the selected WWDG's flag status.\r
 216   * @param  __HANDLE__: WWDG handle\r
 217   * @param  __FLAG__: specifies the flag to check.\r
 218   *         This parameter can be one of the following values:\r
 219   *            @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag\r
 220   * @retval The new state of WWDG_FLAG (SET or RESET).\r
 221   */\r
 222 #define __HAL_WWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))\r
 223 \r
 224 /**\r
 225   * @brief  Clears the WWDG's pending flags.\r
 226   * @param  __HANDLE__: WWDG handle\r
 227   * @param  __FLAG__: specifies the flag to clear.\r
 228   *         This parameter can be one of the following values:\r
 229   *            @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag\r
 230   * @retval None\r
 231   */\r
 232 #define __HAL_WWDG_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = ~(__FLAG__))\r
 233 \r
 234 /** @brief  Checks if the specified WWDG interrupt source is enabled or disabled.\r
 235   * @param  __HANDLE__: WWDG Handle.\r
 236   * @param  __INTERRUPT__: specifies the WWDG interrupt source to check.\r
 237   *          This parameter can be one of the following values:\r
 238   *            @arg WWDG_IT_EWI: Early Wakeup Interrupt\r
 239   * @retval state of __INTERRUPT__ (TRUE or FALSE).\r
 240   */\r
 241 #define __HAL_WWDG_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CFR & (__INTERRUPT__)) == (__INTERRUPT__))\r
 242 \r
 243 /**\r
 244   * @}\r
 245   */\r
 246 \r
 247 /* Exported functions --------------------------------------------------------*/\r
 248 /** @addtogroup WWDG_Exported_Functions\r
 249   * @{\r
 250   */\r
 251 \r
 252 /** @addtogroup WWDG_Exported_Functions_Group1\r
 253   * @{\r
 254   */\r
 255 /* Initialization/de-initialization functions  **********************************/\r
 256 HAL_StatusTypeDef HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg);\r
 257 HAL_StatusTypeDef HAL_WWDG_DeInit(WWDG_HandleTypeDef *hwwdg);\r
 258 void HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg);\r
 259 void HAL_WWDG_MspDeInit(WWDG_HandleTypeDef *hwwdg);\r
 260 void HAL_WWDG_WakeupCallback(WWDG_HandleTypeDef* hwwdg);\r
 261 /**\r
 262   * @}\r
 263   */\r
 264 \r
 265 /** @addtogroup WWDG_Exported_Functions_Group2\r
 266   * @{\r
 267   */\r
 268 /* I/O operation functions ******************************************************/\r
 269 HAL_StatusTypeDef HAL_WWDG_Start(WWDG_HandleTypeDef *hwwdg);\r
 270 HAL_StatusTypeDef HAL_WWDG_Start_IT(WWDG_HandleTypeDef *hwwdg);\r
 271 HAL_StatusTypeDef HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg, uint32_t Counter);\r
 272 void HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg);\r
 273 /**\r
 274   * @}\r
 275   */\r
 276 \r
 277 /** @addtogroup WWDG_Exported_Functions_Group3\r
 278   * @{\r
 279   */\r
 280 /* Peripheral State functions  **************************************************/\r
 281 HAL_WWDG_StateTypeDef HAL_WWDG_GetState(WWDG_HandleTypeDef *hwwdg);\r
 282 /**\r
 283   * @}\r
 284   */ \r
 285 \r
 286 /**\r
 287   * @}\r
 288   */\r
 289 \r
 290 /* Private types -------------------------------------------------------------*/\r
 291 /* Private variables ---------------------------------------------------------*/\r
 292 /* Private constants ---------------------------------------------------------*/\r
 293 /** @defgroup WWDG_Private_Constants WWDG Private Constants\r
 294   * @{\r
 295   */\r
 296 \r
 297 /**\r
 298   * @}\r
 299   */\r
 300 \r
 301 /* Private macros ------------------------------------------------------------*/\r
 302 /** @defgroup WWDG_Private_Macros WWDG Private Macros\r
 303   * @{\r
 304   */\r
 305 #define IS_WWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == WWDG_PRESCALER_1) || \\r
 306                                           ((__PRESCALER__) == WWDG_PRESCALER_2) || \\r
 307                                           ((__PRESCALER__) == WWDG_PRESCALER_4) || \\r
 308                                           ((__PRESCALER__) == WWDG_PRESCALER_8))\r
 309 #define IS_WWDG_WINDOW(__WINDOW__) ((__WINDOW__) <= 0x7F)\r
 310 #define IS_WWDG_COUNTER(__COUNTER__) (((__COUNTER__) >= 0x40) && ((__COUNTER__) <= 0x7F))\r
 311 /**\r
 312   * @}\r
 313   */\r
 314 \r
 315 /* Private functions ---------------------------------------------------------*/\r
 316 /** @defgroup WWDG_Private_Functions WWDG Private Functions\r
 317   * @{\r
 318   */\r
 319 \r
 320 /**\r
 321   * @}\r
 322   */\r
 323 \r
 324 /**\r
 325   * @}\r
 326   */ \r
 327 \r
 328 /**\r
 329   * @}\r
 330   */\r
 331 #ifdef __cplusplus\r
 332 }\r
 333 #endif\r
 334 \r
 335 #endif /* __STM32F7xx_HAL_WWDG_H */\r
 336 \r
 337 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/\r