238 lines
7.0 KiB
C
238 lines
7.0 KiB
C
/**
|
|
******************************************************************************
|
|
* @file stm32l4xx_hal_iwdg.h
|
|
* @author MCD Application Team
|
|
* @brief Header file of IWDG HAL module.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* Copyright (c) 2017 STMicroelectronics.
|
|
* All rights reserved.
|
|
*
|
|
* This software is licensed under terms that can be found in the LICENSE file
|
|
* in the root directory of this software component.
|
|
* If no LICENSE file comes with this software, it is provided AS-IS.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
/* Define to prevent recursive inclusion -------------------------------------*/
|
|
#ifndef STM32L4xx_HAL_IWDG_H
|
|
#define STM32L4xx_HAL_IWDG_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Includes ------------------------------------------------------------------*/
|
|
#include "stm32l4xx_hal_def.h"
|
|
|
|
/** @addtogroup STM32L4xx_HAL_Driver
|
|
* @{
|
|
*/
|
|
|
|
/** @defgroup IWDG IWDG
|
|
* @{
|
|
*/
|
|
|
|
/* Exported types ------------------------------------------------------------*/
|
|
/** @defgroup IWDG_Exported_Types IWDG Exported Types
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief IWDG Init structure definition
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t Prescaler; /*!< Select the prescaler of the IWDG.
|
|
This parameter can be a value of @ref IWDG_Prescaler */
|
|
|
|
uint32_t Reload; /*!< Specifies the IWDG down-counter reload value.
|
|
This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
|
|
|
|
uint32_t Window; /*!< Specifies the window value to be compared to the down-counter.
|
|
This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
|
|
|
|
} IWDG_InitTypeDef;
|
|
|
|
/**
|
|
* @brief IWDG Handle Structure definition
|
|
*/
|
|
typedef struct
|
|
{
|
|
IWDG_TypeDef *Instance; /*!< Register base address */
|
|
|
|
IWDG_InitTypeDef Init; /*!< IWDG required parameters */
|
|
} IWDG_HandleTypeDef;
|
|
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Exported constants --------------------------------------------------------*/
|
|
/** @defgroup IWDG_Exported_Constants IWDG Exported Constants
|
|
* @{
|
|
*/
|
|
|
|
/** @defgroup IWDG_Prescaler IWDG Prescaler
|
|
* @{
|
|
*/
|
|
#define IWDG_PRESCALER_4 0x00000000u /*!< IWDG prescaler set to 4 */
|
|
#define IWDG_PRESCALER_8 IWDG_PR_PR_0 /*!< IWDG prescaler set to 8 */
|
|
#define IWDG_PRESCALER_16 IWDG_PR_PR_1 /*!< IWDG prescaler set to 16 */
|
|
#define IWDG_PRESCALER_32 (IWDG_PR_PR_1 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 32 */
|
|
#define IWDG_PRESCALER_64 IWDG_PR_PR_2 /*!< IWDG prescaler set to 64 */
|
|
#define IWDG_PRESCALER_128 (IWDG_PR_PR_2 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 128 */
|
|
#define IWDG_PRESCALER_256 (IWDG_PR_PR_2 | IWDG_PR_PR_1) /*!< IWDG prescaler set to 256 */
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup IWDG_Window_option IWDG Window option
|
|
* @{
|
|
*/
|
|
#define IWDG_WINDOW_DISABLE IWDG_WINR_WIN
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Exported macros -----------------------------------------------------------*/
|
|
/** @defgroup IWDG_Exported_Macros IWDG Exported Macros
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Enable the IWDG peripheral.
|
|
* @param __HANDLE__ IWDG handle
|
|
* @retval None
|
|
*/
|
|
#define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_ENABLE)
|
|
|
|
/**
|
|
* @brief Reload IWDG counter with value defined in the reload register
|
|
* (write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers disabled).
|
|
* @param __HANDLE__ IWDG handle
|
|
* @retval None
|
|
*/
|
|
#define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_RELOAD)
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Exported functions --------------------------------------------------------*/
|
|
/** @defgroup IWDG_Exported_Functions IWDG Exported Functions
|
|
* @{
|
|
*/
|
|
|
|
/** @defgroup IWDG_Exported_Functions_Group1 Initialization and Start functions
|
|
* @{
|
|
*/
|
|
/* Initialization/Start functions ********************************************/
|
|
HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup IWDG_Exported_Functions_Group2 IO operation functions
|
|
* @{
|
|
*/
|
|
/* I/O operation functions ****************************************************/
|
|
HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Private constants ---------------------------------------------------------*/
|
|
/** @defgroup IWDG_Private_Constants IWDG Private Constants
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief IWDG Key Register BitMask
|
|
*/
|
|
#define IWDG_KEY_RELOAD 0x0000AAAAu /*!< IWDG Reload Counter Enable */
|
|
#define IWDG_KEY_ENABLE 0x0000CCCCu /*!< IWDG Peripheral Enable */
|
|
#define IWDG_KEY_WRITE_ACCESS_ENABLE 0x00005555u /*!< IWDG KR Write Access Enable */
|
|
#define IWDG_KEY_WRITE_ACCESS_DISABLE 0x00000000u /*!< IWDG KR Write Access Disable */
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Private macros ------------------------------------------------------------*/
|
|
/** @defgroup IWDG_Private_Macros IWDG Private Macros
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Enable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers.
|
|
* @param __HANDLE__ IWDG handle
|
|
* @retval None
|
|
*/
|
|
#define IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_ENABLE)
|
|
|
|
/**
|
|
* @brief Disable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers.
|
|
* @param __HANDLE__ IWDG handle
|
|
* @retval None
|
|
*/
|
|
#define IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_DISABLE)
|
|
|
|
/**
|
|
* @brief Check IWDG prescaler value.
|
|
* @param __PRESCALER__ IWDG prescaler value
|
|
* @retval None
|
|
*/
|
|
#define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4) || \
|
|
((__PRESCALER__) == IWDG_PRESCALER_8) || \
|
|
((__PRESCALER__) == IWDG_PRESCALER_16) || \
|
|
((__PRESCALER__) == IWDG_PRESCALER_32) || \
|
|
((__PRESCALER__) == IWDG_PRESCALER_64) || \
|
|
((__PRESCALER__) == IWDG_PRESCALER_128)|| \
|
|
((__PRESCALER__) == IWDG_PRESCALER_256))
|
|
|
|
/**
|
|
* @brief Check IWDG reload value.
|
|
* @param __RELOAD__ IWDG reload value
|
|
* @retval None
|
|
*/
|
|
#define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= IWDG_RLR_RL)
|
|
|
|
/**
|
|
* @brief Check IWDG window value.
|
|
* @param __WINDOW__ IWDG window value
|
|
* @retval None
|
|
*/
|
|
#define IS_IWDG_WINDOW(__WINDOW__) ((__WINDOW__) <= IWDG_WINR_WIN)
|
|
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* STM32L4xx_HAL_IWDG_H */
|