334 lines
15 KiB
C
334 lines
15 KiB
C
/**************************************************************************//**
|
|
* @file ACMP.h
|
|
* @version V0.10
|
|
* $Revision: 10 $
|
|
* $Date: 15/08/11 10:26a $
|
|
* @brief M451 Series ACMP Driver Header File
|
|
*
|
|
* @note
|
|
* Copyright (C) 2014~2015 Nuvoton Technology Corp. All rights reserved.
|
|
*
|
|
******************************************************************************/
|
|
#ifndef __ACMP_H__
|
|
#define __ACMP_H__
|
|
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
/* Include related headers */
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
#include "M451Series.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
|
|
/** @addtogroup Standard_Driver Standard Driver
|
|
@{
|
|
*/
|
|
|
|
/** @addtogroup ACMP_Driver ACMP Driver
|
|
@{
|
|
*/
|
|
|
|
|
|
/** @addtogroup ACMP_EXPORTED_CONSTANTS ACMP Exported Constants
|
|
@{
|
|
*/
|
|
|
|
|
|
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
/* ACMP_CTL constant definitions */
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
#define ACMP_CTL_FILTSEL_OFF (0UL << 13) /*!< ACMP_CTL setting for filter function disabled. */
|
|
#define ACMP_CTL_FILTSEL_1PCLK (1UL << 13) /*!< ACMP_CTL setting for 1 PCLK filter count. */
|
|
#define ACMP_CTL_FILTSEL_2PCLK (2UL << 13) /*!< ACMP_CTL setting for 2 PCLK filter count. */
|
|
#define ACMP_CTL_FILTSEL_4PCLK (3UL << 13) /*!< ACMP_CTL setting for 4 PCLK filter count. */
|
|
#define ACMP_CTL_FILTSEL_8PCLK (4UL << 13) /*!< ACMP_CTL setting for 8 PCLK filter count. */
|
|
#define ACMP_CTL_FILTSEL_16PCLK (5UL << 13) /*!< ACMP_CTL setting for 16 PCLK filter count. */
|
|
#define ACMP_CTL_FILTSEL_32PCLK (6UL << 13) /*!< ACMP_CTL setting for 32 PCLK filter count. */
|
|
#define ACMP_CTL_FILTSEL_64PCLK (7UL << 13) /*!< ACMP_CTL setting for 64 PCLK filter count. */
|
|
#define ACMP_CTL_INTPOL_RF (0UL << 8) /*!< ACMP_CTL setting for selecting rising edge and falling edge as interrupt condition. */
|
|
#define ACMP_CTL_INTPOL_R (1UL << 8) /*!< ACMP_CTL setting for selecting rising edge as interrupt condition. */
|
|
#define ACMP_CTL_INTPOL_F (2UL << 8) /*!< ACMP_CTL setting for selecting falling edge as interrupt condition. */
|
|
#define ACMP_CTL_POSSEL_P0 (0UL << 6) /*!< ACMP_CTL setting for selecting ACMPx_P0 pin as the source of ACMP V+. */
|
|
#define ACMP_CTL_POSSEL_P1 (1UL << 6) /*!< ACMP_CTL setting for selecting ACMPx_P1 pin as the source of ACMP V+. */
|
|
#define ACMP_CTL_POSSEL_P2 (2UL << 6) /*!< ACMP_CTL setting for selecting ACMPx_P2 pin as the source of ACMP V+. */
|
|
#define ACMP_CTL_POSSEL_P3 (3UL << 6) /*!< ACMP_CTL setting for selecting ACMPx_P3 pin as the source of ACMP V+. */
|
|
#define ACMP_CTL_NEGSEL_PIN (0UL << 4) /*!< ACMP_CTL setting for selecting the voltage of ACMP negative input pin as the source of ACMP V-. */
|
|
#define ACMP_CTL_NEGSEL_CRV (1UL << 4) /*!< ACMP_CTL setting for selecting internal comparator reference voltage as the source of ACMP V-. */
|
|
#define ACMP_CTL_NEGSEL_VBG (2UL << 4) /*!< ACMP_CTL setting for selecting internal Band-gap voltage as the source of ACMP V-. */
|
|
#define ACMP_CTL_NEGSEL_DAC (3UL << 4) /*!< ACMP_CTL setting for selecting DAC output voltage as the source of ACMP V-. */
|
|
#define ACMP_CTL_HYSTERESIS_ENABLE (1UL << 2) /*!< ACMP_CTL setting for enabling the hysteresis function. */
|
|
#define ACMP_CTL_HYSTERESIS_DISABLE (0UL << 2) /*!< ACMP_CTL setting for disabling the hysteresis function. */
|
|
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
/* ACMP_VREF constant definitions */
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
#define ACMP_VREF_CRVSSEL_VDDA (0UL << 6) /*!< ACMP_VREF setting for selecting analog supply voltage VDDA as the CRV source voltage */
|
|
#define ACMP_VREF_CRVSSEL_INTVREF (1UL << 6) /*!< ACMP_VREF setting for selecting internal reference voltage as the CRV source voltage */
|
|
|
|
|
|
/*@}*/ /* end of group ACMP_EXPORTED_CONSTANTS */
|
|
|
|
|
|
/** @addtogroup ACMP_EXPORTED_FUNCTIONS ACMP Exported Functions
|
|
@{
|
|
*/
|
|
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
/* Define Macros and functions */
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
|
|
|
|
/**
|
|
* @brief This macro is used to enable output inverse function
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will set ACMPOINV bit of ACMP_CTL register to enable output inverse function.
|
|
*/
|
|
#define ACMP_ENABLE_OUTPUT_INVERSE(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] |= ACMP_CTL_ACMPOINV_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to disable output inverse function
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will clear ACMPOINV bit of ACMP_CTL register to disable output inverse function.
|
|
*/
|
|
#define ACMP_DISABLE_OUTPUT_INVERSE(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] &= ~ACMP_CTL_ACMPOINV_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to select ACMP negative input source
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @param[in] u32Src is comparator negative input selection. Including:
|
|
* - \ref ACMP_CTL_NEGSEL_PIN
|
|
* - \ref ACMP_CTL_NEGSEL_CRV
|
|
* - \ref ACMP_CTL_NEGSEL_VBG
|
|
* - \ref ACMP_CTL_NEGSEL_DAC
|
|
* @return None
|
|
* @details This macro will set NEGSEL (ACMP_CTL[5:4]) to determine the source of negative input.
|
|
*/
|
|
#define ACMP_SET_NEG_SRC(acmp, u32ChNum, u32Src) ((acmp)->CTL[(u32ChNum)%2] = ((acmp)->CTL[(u32ChNum)%2] & ~ACMP_CTL_NEGSEL_Msk) | (u32Src))
|
|
|
|
/**
|
|
* @brief This macro is used to enable hysteresis function
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will set HYSEN bit of ACMP_CTL register to enable hysteresis function.
|
|
*/
|
|
#define ACMP_ENABLE_HYSTERESIS(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] |= ACMP_CTL_HYSEN_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to disable hysteresis function
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will clear HYSEN bit of ACMP_CTL register to disable hysteresis function.
|
|
*/
|
|
#define ACMP_DISABLE_HYSTERESIS(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] &= ~ACMP_CTL_HYSEN_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to enable interrupt
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will set ACMPIE bit of ACMP_CTL register to enable interrupt function.
|
|
* If wake-up function is enabled, the wake-up interrupt will be enabled as well.
|
|
*/
|
|
#define ACMP_ENABLE_INT(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] |= ACMP_CTL_ACMPIE_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to disable interrupt
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will clear ACMPIE bit of ACMP_CTL register to disable interrupt function.
|
|
*/
|
|
#define ACMP_DISABLE_INT(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] &= ~ACMP_CTL_ACMPIE_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to enable ACMP
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will set ACMPEN bit of ACMP_CTL register to enable analog comparator.
|
|
*/
|
|
#define ACMP_ENABLE(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] |= ACMP_CTL_ACMPEN_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to disable ACMP
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will clear ACMPEN bit of ACMP_CTL register to disable analog comparator.
|
|
*/
|
|
#define ACMP_DISABLE(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] &= ~ACMP_CTL_ACMPEN_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to get ACMP output value
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return ACMP output value
|
|
* @details This macro will return the ACMP output value.
|
|
*/
|
|
#define ACMP_GET_OUTPUT(acmp, u32ChNum) (((acmp)->STATUS & (ACMP_STATUS_ACMPO0_Msk<<((u32ChNum)%2)))?1:0)
|
|
|
|
/**
|
|
* @brief This macro is used to get ACMP interrupt flag
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return ACMP interrupt occurred (1) or not (0)
|
|
* @details This macro will return the ACMP interrupt flag.
|
|
*/
|
|
#define ACMP_GET_INT_FLAG(acmp, u32ChNum) (((acmp)->STATUS & (ACMP_STATUS_ACMPIF0_Msk<<((u32ChNum)%2)))?1:0)
|
|
|
|
/**
|
|
* @brief This macro is used to clear ACMP interrupt flag
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will write 1 to ACMPIFn bit of ACMP_STATUS register to clear interrupt flag.
|
|
*/
|
|
#define ACMP_CLR_INT_FLAG(acmp, u32ChNum) ((acmp)->STATUS = (ACMP_STATUS_ACMPIF0_Msk<<((u32ChNum)%2)))
|
|
|
|
/**
|
|
* @brief This macro is used to clear ACMP wake-up interrupt flag
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will write 1 to WKIFn bit of ACMP_STATUS register to clear interrupt flag.
|
|
*/
|
|
#define ACMP_CLR_WAKEUP_INT_FLAG(acmp, u32ChNum) ((acmp)->STATUS = (ACMP_STATUS_WKIF0_Msk<<((u32ChNum)%2)))
|
|
|
|
/**
|
|
* @brief This macro is used to enable ACMP wake-up function
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will set WKEN (ACMP_CTL[16]) to enable ACMP wake-up function.
|
|
*/
|
|
#define ACMP_ENABLE_WAKEUP(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] |= ACMP_CTL_WKEN_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to disable ACMP wake-up function
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will clear WKEN (ACMP_CTL[16]) to disable ACMP wake-up function.
|
|
*/
|
|
#define ACMP_DISABLE_WAKEUP(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] &= ~ACMP_CTL_WKEN_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to select ACMP positive input pin
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @param[in] u32Pin Comparator positive pin selection. Including:
|
|
* - \ref ACMP_CTL_POSSEL_P0
|
|
* - \ref ACMP_CTL_POSSEL_P1
|
|
* - \ref ACMP_CTL_POSSEL_P2
|
|
* - \ref ACMP_CTL_POSSEL_P3
|
|
* @return None
|
|
* @details This macro will set POSSEL (ACMP_CTL[7:6]) to determine the comparator positive input pin.
|
|
*/
|
|
#define ACMP_SELECT_P(acmp, u32ChNum, u32Pin) ((acmp)->CTL[(u32ChNum)%2] = ((acmp)->CTL[(u32ChNum)%2] & ~ACMP_CTL_POSSEL_Msk) | (u32Pin))
|
|
|
|
/**
|
|
* @brief This macro is used to enable ACMP filter function
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will set OUTSEL (ACMP_CTL[12]) to enable output filter function.
|
|
*/
|
|
#define ACMP_ENABLE_FILTER(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] |= ACMP_CTL_OUTSEL_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to disable ACMP filter function
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @return None
|
|
* @details This macro will clear OUTSEL (ACMP_CTL[12]) to disable output filter function.
|
|
*/
|
|
#define ACMP_DISABLE_FILTER(acmp, u32ChNum) ((acmp)->CTL[(u32ChNum)%2] &= ~ACMP_CTL_OUTSEL_Msk)
|
|
|
|
/**
|
|
* @brief This macro is used to set ACMP filter function
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @param[in] u32Cnt is comparator filter count setting.
|
|
* - \ref ACMP_CTL_FILTSEL_OFF
|
|
* - \ref ACMP_CTL_FILTSEL_1PCLK
|
|
* - \ref ACMP_CTL_FILTSEL_2PCLK
|
|
* - \ref ACMP_CTL_FILTSEL_4PCLK
|
|
* - \ref ACMP_CTL_FILTSEL_8PCLK
|
|
* - \ref ACMP_CTL_FILTSEL_16PCLK
|
|
* - \ref ACMP_CTL_FILTSEL_32PCLK
|
|
* - \ref ACMP_CTL_FILTSEL_64PCLK
|
|
* @return None
|
|
* @details When ACMP output filter function is enabled, the output sampling count is determined by FILTSEL (ACMP_CTL[15:13]).
|
|
*/
|
|
#define ACMP_SET_FILTER(acmp, u32ChNum, u32Cnt) ((acmp)->CTL[(u32ChNum)%2] = ((acmp)->CTL[(u32ChNum)%2] & ~ACMP_CTL_FILTSEL_Msk) | (u32Cnt))
|
|
|
|
/**
|
|
* @brief This macro is used to select comparator reference voltage
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32Level The comparator reference voltage setting.
|
|
* The formula is:
|
|
* comparator reference voltage = CRV source voltage x (1/6 + u32Level/24)
|
|
* The range of u32Level is 0 ~ 15.
|
|
* @return None
|
|
* @details When CRV is selected as ACMP negative input source, the CRV level is determined by CRVCTL (ACMP_VREF[3:0]).
|
|
*/
|
|
#define ACMP_CRV_SEL(acmp, u32Level) ((acmp)->VREF = ((acmp)->VREF & ~ACMP_VREF_CRVCTL_Msk) | ((u32Level)<<ACMP_VREF_CRVCTL_Pos))
|
|
|
|
/**
|
|
* @brief This macro is used to select the source of CRV
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32Src is the source of CRV. Including:
|
|
* - \ref ACMP_VREF_CRVSSEL_VDDA
|
|
* - \ref ACMP_VREF_CRVSSEL_INTVREF
|
|
* @return None
|
|
* @details The source of CRV can be VDDA or internal reference voltage. The internal reference voltage level is determined by SYS_VREFCTL register.
|
|
*/
|
|
#define ACMP_SELECT_CRV_SRC(acmp, u32Src) ((acmp)->VREF = ((acmp)->VREF & ~ACMP_VREF_CRVSSEL_Msk) | (u32Src))
|
|
|
|
/**
|
|
* @brief This macro is used to select ACMP interrupt condition
|
|
* @param[in] acmp The pointer of the specified ACMP module
|
|
* @param[in] u32ChNum The ACMP number
|
|
* @param[in] u32Cond Comparator interrupt condition selection. Including:
|
|
* - \ref ACMP_CTL_INTPOL_RF
|
|
* - \ref ACMP_CTL_INTPOL_R
|
|
* - \ref ACMP_CTL_INTPOL_F
|
|
* @return None
|
|
* @details The ACMP output interrupt condition can be rising edge, falling edge or any edge.
|
|
*/
|
|
#define ACMP_SELECT_INT_COND(acmp, u32ChNum, u32Cond) ((acmp)->CTL[(u32ChNum)%2] = ((acmp)->CTL[(u32ChNum)%2] & ~ACMP_CTL_INTPOL_Msk) | (u32Cond))
|
|
|
|
|
|
|
|
/* Function prototype declaration */
|
|
void ACMP_Open(ACMP_T *, uint32_t u32ChNum, uint32_t u32NegSrc, uint32_t u32HysteresisEn);
|
|
void ACMP_Close(ACMP_T *, uint32_t u32ChNum);
|
|
|
|
|
|
|
|
/*@}*/ /* end of group ACMP_EXPORTED_FUNCTIONS */
|
|
|
|
/*@}*/ /* end of group ACMP_Driver */
|
|
|
|
/*@}*/ /* end of group Standard_Driver */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
|
|
#endif //__ACMP_H__
|
|
|
|
/*** (C) COPYRIGHT 2014~2015 Nuvoton Technology Corp. ***/
|