515 lines
32 KiB
C
515 lines
32 KiB
C
|
/**************************************************************************//**
|
||
|
|
* @file nu_pwm.h
|
||
|
|
* @version V1.00
|
||
|
|
* $Revision: 9 $
|
||
|
|
* $Date: 18/06/07 3:47p $
|
||
|
|
* @brief M031 series PWM driver header file
|
||
|
|
*
|
||
|
|
* SPDX-License-Identifier: Apache-2.0
|
||
|
|
* @copyright (C) 2018 Nuvoton Technology Corp. All rights reserved.
|
||
|
|
*****************************************************************************/
|
||
|
|
#ifndef __NU_PWM_H__
|
||
|
|
#define __NU_PWM_H__
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C"
|
||
|
|
{
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
/** @addtogroup Standard_Driver Standard Driver
|
||
|
|
@{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @addtogroup PWM_Driver PWM Driver
|
||
|
|
@{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @addtogroup PWM_EXPORTED_CONSTANTS PWM Exported Constants
|
||
|
|
@{
|
||
|
|
*/
|
||
|
|
#define PWM_CHANNEL_NUM (6UL) /*!< PWM channel number \hideinitializer */
|
||
|
|
#define PWM_CH_0_MASK (0x1UL) /*!< PWM channel 0 mask \hideinitializer */
|
||
|
|
#define PWM_CH_1_MASK (0x2UL) /*!< PWM channel 1 mask \hideinitializer */
|
||
|
|
#define PWM_CH_2_MASK (0x4UL) /*!< PWM channel 2 mask \hideinitializer */
|
||
|
|
#define PWM_CH_3_MASK (0x8UL) /*!< PWM channel 3 mask \hideinitializer */
|
||
|
|
#define PWM_CH_4_MASK (0x10UL) /*!< PWM channel 4 mask \hideinitializer */
|
||
|
|
#define PWM_CH_5_MASK (0x20UL) /*!< PWM channel 5 mask \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Counter Type Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_UP_COUNTER (0UL) /*!< Up counter type \hideinitializer */
|
||
|
|
#define PWM_DOWN_COUNTER (1UL) /*!< Down counter type \hideinitializer */
|
||
|
|
#define PWM_UP_DOWN_COUNTER (2UL) /*!< Up-Down counter type \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Aligned Type Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_EDGE_ALIGNED (1UL) /*!< PWM working in edge aligned type(down count) \hideinitializer */
|
||
|
|
#define PWM_CENTER_ALIGNED (2UL) /*!< PWM working in center aligned type \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Output Level Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_OUTPUT_NOTHING (0UL) /*!< PWM output nothing \hideinitializer */
|
||
|
|
#define PWM_OUTPUT_LOW (1UL) /*!< PWM output low \hideinitializer */
|
||
|
|
#define PWM_OUTPUT_HIGH (2UL) /*!< PWM output high \hideinitializer */
|
||
|
|
#define PWM_OUTPUT_TOGGLE (3UL) /*!< PWM output toggle \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Synchronous Start Function Control Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_SSCTL_SSRC_PWM0 (0UL<<PWM_SSCTL_SSRC_Pos) /*!< Synchronous start source comes from PWM0 \hideinitializer */
|
||
|
|
#define PWM_SSCTL_SSRC_PWM1 (1UL<<PWM_SSCTL_SSRC_Pos) /*!< Synchronous start source comes from PWM1 \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Trigger Source Select Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_TRIGGER_ADC_EVEN_ZERO_POINT (0UL) /*!< PWM trigger ADC while counter of even channel matches zero point \hideinitializer */
|
||
|
|
#define PWM_TRIGGER_ADC_EVEN_PERIOD_POINT (1UL) /*!< PWM trigger ADC while counter of even channel matches period point \hideinitializer */
|
||
|
|
#define PWM_TRIGGER_ADC_EVEN_ZERO_OR_PERIOD_POINT (2UL) /*!< PWM trigger ADC while counter of even channel matches zero or period point \hideinitializer */
|
||
|
|
#define PWM_TRIGGER_ADC_EVEN_COMPARE_UP_COUNT_POINT (3UL) /*!< PWM trigger ADC while counter of even channel matches up count to comparator point \hideinitializer */
|
||
|
|
#define PWM_TRIGGER_ADC_EVEN_COMPARE_DOWN_COUNT_POINT (4UL) /*!< PWM trigger ADC while counter of even channel matches down count to comparator point \hideinitializer */
|
||
|
|
#define PWM_TRIGGER_ADC_ODD_COMPARE_UP_COUNT_POINT (8UL) /*!< PWM trigger ADC while counter of odd channel matches up count to comparator point \hideinitializer */
|
||
|
|
#define PWM_TRIGGER_ADC_ODD_COMPARE_DOWN_COUNT_POINT (9UL) /*!< PWM trigger ADC while counter of odd channel matches down count to comparator point \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Fail brake Control Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_FB_EDGE_ACMP0 (PWM_BRKCTL0_1_CPO0EBEN_Msk) /*!< Comparator 0 as edge-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_EDGE_ACMP1 (PWM_BRKCTL0_1_CPO1EBEN_Msk) /*!< Comparator 1 as edge-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_EDGE_BKP0 (PWM_BRKCTL0_1_BRKP0EEN_Msk) /*!< BKP0 pin as edge-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_EDGE_BKP1 (PWM_BRKCTL0_1_BRKP1EEN_Msk) /*!< BKP1 pin as edge-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_EDGE_ADCRM (PWM_BRKCTL0_1_ADCEBEN_Msk) /*!< ADC Result Monitor (ADCRM) as edge-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_EDGE_SYS_CSS (PWM_BRKCTL0_1_SYSEBEN_Msk | PWM_FAILBRK_CSSBRKEN_Msk) /*!< System fail condition: clock security system detection as edge-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_EDGE_SYS_BOD (PWM_BRKCTL0_1_SYSEBEN_Msk | PWM_FAILBRK_BODBRKEN_Msk) /*!< System fail condition: brown-out detection as edge-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_EDGE_SYS_COR (PWM_BRKCTL0_1_SYSEBEN_Msk | PWM_FAILBRK_CORBRKEN_Msk) /*!< System fail condition: core lockup detection as edge-detect fault brake source \hideinitializer */
|
||
|
|
|
||
|
|
#define PWM_FB_LEVEL_ACMP0 (PWM_BRKCTL0_1_CPO0LBEN_Msk) /*!< Comparator 0 as level-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_LEVEL_ACMP1 (PWM_BRKCTL0_1_CPO1LBEN_Msk) /*!< Comparator 1 as level-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_LEVEL_BKP0 (PWM_BRKCTL0_1_BRKP0LEN_Msk) /*!< BKP0 pin as level-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_LEVEL_BKP1 (PWM_BRKCTL0_1_BRKP1LEN_Msk) /*!< BKP1 pin as level-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_LEVEL_ADCRM (PWM_BRKCTL0_1_ADCLBEN_Msk) /*!< ADC Result Monitor (ADCRM) as level-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_LEVEL_SYS_CSS (PWM_BRKCTL0_1_SYSLBEN_Msk | PWM_FAILBRK_CSSBRKEN_Msk) /*!< System fail condition: clock security system detection as level-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_LEVEL_SYS_BOD (PWM_BRKCTL0_1_SYSLBEN_Msk | PWM_FAILBRK_BODBRKEN_Msk) /*!< System fail condition: brown-out detection as level-detect fault brake source \hideinitializer */
|
||
|
|
#define PWM_FB_LEVEL_SYS_COR (PWM_BRKCTL0_1_SYSLBEN_Msk | PWM_FAILBRK_CORBRKEN_Msk) /*!< System fail condition: core lockup detection as level-detect fault brake source \hideinitializer */
|
||
|
|
|
||
|
|
#define PWM_FB_EDGE (0UL) /*!< Edge-detect fault brake \hideinitializer */
|
||
|
|
#define PWM_FB_LEVEL (8UL) /*!< Level-detect fault brake \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Capture Control Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_CAPTURE_INT_RISING_LATCH (1UL) /*!< PWM capture interrupt if channel has rising transition \hideinitializer */
|
||
|
|
#define PWM_CAPTURE_INT_FALLING_LATCH (0x100UL) /*!< PWM capture interrupt if channel has falling transition \hideinitializer */
|
||
|
|
|
||
|
|
#define PWM_CAPTURE_PDMA_RISING_LATCH (0x2UL) /*!< PWM capture rising latched data transfer by PDMA \hideinitializer */
|
||
|
|
#define PWM_CAPTURE_PDMA_FALLING_LATCH (0x4UL) /*!< PWM capture falling latched data transfer by PDMA \hideinitializer */
|
||
|
|
#define PWM_CAPTURE_PDMA_RISING_FALLING_LATCH (0x6UL) /*!< PWM capture rising and falling latched data transfer by PDMA \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Duty Interrupt Type Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_DUTY_INT_DOWN_COUNT_MATCH_CMP (PWM_INTEN0_CMPDIEN0_Msk) /*!< PWM duty interrupt triggered if down count match comparator \hideinitializer */
|
||
|
|
#define PWM_DUTY_INT_UP_COUNT_MATCH_CMP (PWM_INTEN0_CMPUIEN0_Msk) /*!< PWM duty interrupt triggered if up count match comparator \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Load Mode Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_LOAD_MODE_IMMEDIATE (PWM_CTL0_IMMLDEN0_Msk) /*!< PWM immediately load mode \hideinitializer */
|
||
|
|
#define PWM_LOAD_MODE_CENTER (PWM_CTL0_CTRLD0_Msk) /*!< PWM center load mode \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Synchronize Control Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_SYNC_OUT_FROM_SYNCIN_SWSYNC (0UL) /*!< Synchronize source from SYNC_IN or SWSYNC \hideinitializer */
|
||
|
|
#define PWM_SYNC_OUT_FROM_COUNT_TO_ZERO (1UL) /*!< Synchronize source from counter equal to 0 \hideinitializer */
|
||
|
|
#define PWM_SYNC_OUT_FROM_COUNT_TO_COMPARATOR (2UL) /*!< Synchronize source from counter equal to CMPDAT1, CMPDAT3, CMPDAT5 \hideinitializer */
|
||
|
|
#define PWM_SYNC_OUT_DISABLE (3UL) /*!< SYNC_OUT will not be generated \hideinitializer */
|
||
|
|
#define PWM_PHS_DIR_DECREMENT (0UL) /*!< PWM counter count decrement \hideinitializer */
|
||
|
|
#define PWM_PHS_DIR_INCREMENT (1UL) /*!< PWM counter count increment \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Noise Filter Clock Divide Select Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_NF_CLK_DIV_1 (0UL) /*!< Noise filter clock is HCLK divide by 1 \hideinitializer */
|
||
|
|
#define PWM_NF_CLK_DIV_2 (1UL) /*!< Noise filter clock is HCLK divide by 2 \hideinitializer */
|
||
|
|
#define PWM_NF_CLK_DIV_4 (2UL) /*!< Noise filter clock is HCLK divide by 4 \hideinitializer */
|
||
|
|
#define PWM_NF_CLK_DIV_8 (3UL) /*!< Noise filter clock is HCLK divide by 8 \hideinitializer */
|
||
|
|
#define PWM_NF_CLK_DIV_16 (4UL) /*!< Noise filter clock is HCLK divide by 16 \hideinitializer */
|
||
|
|
#define PWM_NF_CLK_DIV_32 (5UL) /*!< Noise filter clock is HCLK divide by 32 \hideinitializer */
|
||
|
|
#define PWM_NF_CLK_DIV_64 (6UL) /*!< Noise filter clock is HCLK divide by 64 \hideinitializer */
|
||
|
|
#define PWM_NF_CLK_DIV_128 (7UL) /*!< Noise filter clock is HCLK divide by 128 \hideinitializer */
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Clock Source Select Constant Definitions */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
#define PWM_CLKSRC_PWM_CLK (0UL) /*!< PWM Clock source selects to PWM0_CLK or PWM1_CLK \hideinitializer */
|
||
|
|
#define PWM_CLKSRC_TIMER0 (1UL) /*!< PWM Clock source selects to TIMER0 overflow \hideinitializer */
|
||
|
|
#define PWM_CLKSRC_TIMER1 (2UL) /*!< PWM Clock source selects to TIMER1 overflow \hideinitializer */
|
||
|
|
#define PWM_CLKSRC_TIMER2 (3UL) /*!< PWM Clock source selects to TIMER2 overflow \hideinitializer */
|
||
|
|
#define PWM_CLKSRC_TIMER3 (4UL) /*!< PWM Clock source selects to TIMER3 overflow \hideinitializer */
|
||
|
|
|
||
|
|
|
||
|
|
/*@}*/ /* end of group PWM_EXPORTED_CONSTANTS */
|
||
|
|
|
||
|
|
|
||
|
|
/** @addtogroup PWM_EXPORTED_FUNCTIONS PWM Exported Functions
|
||
|
|
@{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro enable complementary mode
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to enable complementary mode of PWM module.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_ENABLE_COMPLEMENTARY_MODE(pwm) ((pwm)->CTL1 = (pwm)->CTL1 | (0x7ul<<PWM_CTL1_OUTMODE0_Pos))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro disable complementary mode, and enable independent mode.
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to disable complementary mode of PWM module.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_DISABLE_COMPLEMENTARY_MODE(pwm) ((pwm)->CTL1 = (pwm)->CTL1 & ~(0x7ul<<PWM_CTL1_OUTMODE0_Pos))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Enable timer synchronous start counting function of specified channel(s)
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelMask Combination of enabled channels. Each bit corresponds to a channel
|
||
|
|
* Bit 0 represents channel 0, bit 1 represents channel 1...
|
||
|
|
* @param[in] u32SyncSrc Synchronous start source selection, valid values are:
|
||
|
|
* - \ref PWM_SSCTL_SSRC_PWM0
|
||
|
|
* - \ref PWM_SSCTL_SSRC_PWM1
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to enable timer synchronous start counting function of specified channel(s).
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_ENABLE_TIMER_SYNC(pwm, u32ChannelMask, u32SyncSrc) ((pwm)->SSCTL = ((pwm)->SSCTL & ~PWM_SSCTL_SSRC_Msk) | (u32SyncSrc) | (u32ChannelMask))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Disable timer synchronous start counting function of specified channel(s)
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelMask Combination of enabled channels. Each bit corresponds to a channel
|
||
|
|
* Bit 0 represents channel 0, bit 1 represents channel 1...
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to disable timer synchronous start counting function of specified channel(s).
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_DISABLE_TIMER_SYNC(pwm, u32ChannelMask) \
|
||
|
|
do{ \
|
||
|
|
int i;\
|
||
|
|
for(i = 0; i < 6; i++) { \
|
||
|
|
if((u32ChannelMask) & (1 << i)) \
|
||
|
|
(pwm)->SSCTL &= ~(1UL << i); \
|
||
|
|
} \
|
||
|
|
}while(0)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro enable PWM counter synchronous start counting function.
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to make selected PWM0 and PWM1 channel(s) start counting at the same time.
|
||
|
|
* To configure synchronous start counting channel(s) by PWM_ENABLE_TIMER_SYNC() and PWM_DISABLE_TIMER_SYNC().
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_TRIGGER_SYNC_START(pwm) ((pwm)->SSTRG = PWM_SSTRG_CNTSEN_Msk)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro enable output inverter of specified channel(s)
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelMask Combination of enabled channels. Each bit corresponds to a channel
|
||
|
|
* Bit 0 represents channel 0, bit 1 represents channel 1...
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to enable output inverter of specified channel(s).
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_ENABLE_OUTPUT_INVERTER(pwm, u32ChannelMask) ((pwm)->POLCTL = (u32ChannelMask))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro get captured rising data
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelNum PWM channel number. Valid values are between 0~5
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to get captured rising data of specified channel.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_GET_CAPTURE_RISING_DATA(pwm, u32ChannelNum) (*(__IO uint32_t *) (&((pwm)->RCAPDAT0) + ((u32ChannelNum) << 1)))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro get captured falling data
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelNum PWM channel number. Valid values are between 0~5
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to get captured falling data of specified channel.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_GET_CAPTURE_FALLING_DATA(pwm, u32ChannelNum) (*(__IO uint32_t *) (&((pwm)->FCAPDAT0) + ((u32ChannelNum) << 1)))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro mask output logic to high or low
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelMask Combination of enabled channels. Each bit corresponds to a channel
|
||
|
|
* Bit 0 represents channel 0, bit 1 represents channel 1...
|
||
|
|
* @param[in] u32LevelMask Output logic to high or low
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to mask output logic to high or low of specified channel(s).
|
||
|
|
* @note If u32ChannelMask parameter is 0, then mask function will be disabled.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_MASK_OUTPUT(pwm, u32ChannelMask, u32LevelMask) \
|
||
|
|
{ \
|
||
|
|
(pwm)->MSKEN = (u32ChannelMask); \
|
||
|
|
(pwm)->MSK = (u32LevelMask); \
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro set the prescaler of the selected channel
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelNum PWM channel number. Valid values are between 0~5
|
||
|
|
* @param[in] u32Prescaler Clock prescaler of specified channel. Valid values are between 0 ~ 0xFFF
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to set the prescaler of specified channel.
|
||
|
|
* @note Every even channel N, and channel (N + 1) share a prescaler. So if channel 0 prescaler changed, channel 1 will also be affected.
|
||
|
|
* The clock of PWM counter is divided by (u32Prescaler + 1).
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_SET_PRESCALER(pwm, u32ChannelNum, u32Prescaler) ((pwm)->CLKPSC[(u32ChannelNum) >> 1] = (u32Prescaler))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro get the prescaler of the selected channel
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelNum PWM channel number. Valid values are between 0~5
|
||
|
|
* @return Return Clock prescaler of specified channel. Valid values are between 0 ~ 0xFFF
|
||
|
|
* @details This macro is used to get the prescaler of specified channel.
|
||
|
|
* @note Every even channel N, and channel (N + 1) share a prescaler. So if channel 0 prescaler changed, channel 1 will also be affected.
|
||
|
|
* The clock of PWM counter is divided by (u32Prescaler + 1).
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_GET_PRESCALER(pwm, u32ChannelNum) (*(__IO uint32_t *) (&((pwm)->CLKPSC[0]) + ((u32ChannelNum) >> 1)))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro set the comparator of the selected channel
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelNum PWM channel number. Valid values are between 0~5
|
||
|
|
* @param[in] u32CMR Comparator of specified channel. Valid values are between 0~0xFFFF
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to set the comparator of specified channel.
|
||
|
|
* @note This new setting will take effect on next PWM period.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_SET_CMR(pwm, u32ChannelNum, u32CMR) ((pwm)->CMPDAT[(u32ChannelNum)]= (u32CMR))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro get the comparator of the selected channel
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelNum PWM channel number. Valid values are between 0~5
|
||
|
|
* @return Return the comparator of specified channel. Valid values are between 0~0xFFFF
|
||
|
|
* @details This macro is used to get the comparator of specified channel.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_GET_CMR(pwm, u32ChannelNum) ((pwm)->CMPDAT[(u32ChannelNum)])
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro set the period of the selected channel
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelNum PWM channel number. Valid values are between 0~5
|
||
|
|
* @param[in] u32CNR Period of specified channel. Valid values are between 0~0xFFFF
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to set the period of specified channel.
|
||
|
|
* @note This new setting will take effect on next PWM period.
|
||
|
|
* @note PWM counter will stop if period length set to 0.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_SET_CNR(pwm, u32ChannelNum, u32CNR) ((pwm)->PERIOD[(u32ChannelNum>>1)<<1] = (u32CNR))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro get the period of the selected channel
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelNum PWM channel number. Valid values are between 0~5
|
||
|
|
* @return Return the period of specified channel. Valid values are between 0~0xFFFF
|
||
|
|
* @details This macro is used to get the period of specified channel.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_GET_CNR(pwm, u32ChannelNum) ((pwm)->PERIOD[(u32ChannelNum>>1)<<1])
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This macro set the PWM aligned type
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelMask Combination of enabled channels. Each bit corresponds to a channel
|
||
|
|
* Bit 0 represents channel 0, bit 1 represents channel 1...
|
||
|
|
* @param[in] u32AlignedType PWM aligned type, valid values are:
|
||
|
|
* - \ref PWM_EDGE_ALIGNED
|
||
|
|
* - \ref PWM_CENTER_ALIGNED
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to set the PWM aligned type of specified channel(s).
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_SET_ALIGNED_TYPE(pwm, u32ChannelMask, u32AlignedType) \
|
||
|
|
do{ \
|
||
|
|
int i; \
|
||
|
|
for(i = 0; i < 6; i++) { \
|
||
|
|
if((u32ChannelMask) & (1 << i)) \
|
||
|
|
(pwm)->CTL1 = (((pwm)->CTL1 & ~(3UL << (i << 1))) | ((u32AlignedType) << (i << 1))); \
|
||
|
|
} \
|
||
|
|
}while(0)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Clear counter of specified channel(s)
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelMask Combination of enabled channels. Each bit corresponds to a channel
|
||
|
|
* Bit 0 represents channel 0, bit 1 represents channel 1...
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to clear counter of specified channel(s).
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_CLR_COUNTER(pwm, u32ChannelMask) \
|
||
|
|
do{ \
|
||
|
|
uint32_t i; \
|
||
|
|
for(i = 0UL; i < 6UL; i++) { \
|
||
|
|
if((u32ChannelMask) & (1UL << i)) \
|
||
|
|
((pwm)->CNTCLR |= (1UL << ((i >> 1UL) << 1UL))); \
|
||
|
|
} \
|
||
|
|
}while(0)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Set output level at zero, compare up, period(center) and compare down of specified channel(s)
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelMask Combination of enabled channels. Each bit corresponds to a channel
|
||
|
|
* Bit 0 represents channel 0, bit 1 represents channel 1...
|
||
|
|
* @param[in] u32ZeroLevel output level at zero point, valid values are:
|
||
|
|
* - \ref PWM_OUTPUT_NOTHING
|
||
|
|
* - \ref PWM_OUTPUT_LOW
|
||
|
|
* - \ref PWM_OUTPUT_HIGH
|
||
|
|
* - \ref PWM_OUTPUT_TOGGLE
|
||
|
|
* @param[in] u32CmpUpLevel output level at compare up point, valid values are:
|
||
|
|
* - \ref PWM_OUTPUT_NOTHING
|
||
|
|
* - \ref PWM_OUTPUT_LOW
|
||
|
|
* - \ref PWM_OUTPUT_HIGH
|
||
|
|
* - \ref PWM_OUTPUT_TOGGLE
|
||
|
|
* @param[in] u32PeriodLevel output level at period(center) point, valid values are:
|
||
|
|
* - \ref PWM_OUTPUT_NOTHING
|
||
|
|
* - \ref PWM_OUTPUT_LOW
|
||
|
|
* - \ref PWM_OUTPUT_HIGH
|
||
|
|
* - \ref PWM_OUTPUT_TOGGLE
|
||
|
|
* @param[in] u32CmpDownLevel output level at compare down point, valid values are:
|
||
|
|
* - \ref PWM_OUTPUT_NOTHING
|
||
|
|
* - \ref PWM_OUTPUT_LOW
|
||
|
|
* - \ref PWM_OUTPUT_HIGH
|
||
|
|
* - \ref PWM_OUTPUT_TOGGLE
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to Set output level at zero, compare up, period(center) and compare down of specified channel(s).
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_SET_OUTPUT_LEVEL(pwm, u32ChannelMask, u32ZeroLevel, u32CmpUpLevel, u32PeriodLevel, u32CmpDownLevel) \
|
||
|
|
do{ \
|
||
|
|
int i; \
|
||
|
|
for(i = 0; i < 6; i++) { \
|
||
|
|
if((u32ChannelMask) & (1 << i)) { \
|
||
|
|
(pwm)->WGCTL0 = (((pwm)->WGCTL0 & ~(3UL << (i << 1))) | ((u32ZeroLevel) << (i << 1))); \
|
||
|
|
(pwm)->WGCTL0 = (((pwm)->WGCTL0 & ~(3UL << (PWM_WGCTL0_PRDPCTL0_Pos + (i << 1)))) | ((u32PeriodLevel) << (PWM_WGCTL0_PRDPCTL0_Pos + (i << 1)))); \
|
||
|
|
(pwm)->WGCTL1 = (((pwm)->WGCTL1 & ~(3UL << (i << 1))) | ((u32CmpUpLevel) << (i << 1))); \
|
||
|
|
(pwm)->WGCTL1 = (((pwm)->WGCTL1 & ~(3UL << (PWM_WGCTL1_CMPDCTL0_Pos + (i << 1)))) | ((u32CmpDownLevel) << (PWM_WGCTL1_CMPDCTL0_Pos + (i << 1)))); \
|
||
|
|
} \
|
||
|
|
} \
|
||
|
|
}while(0)
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Trigger brake event from specified channel(s)
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelMask Combination of enabled channels. Each bit corresponds to a channel
|
||
|
|
* Bit 0 represents channel 0, bit 1 represents channel 2 and bit 2 represents channel 4
|
||
|
|
* @param[in] u32BrakeType Type of brake trigger. PWM_FB_EDGE of this macro is only supported in M45xD/M45xC.
|
||
|
|
* - \ref PWM_FB_EDGE
|
||
|
|
* - \ref PWM_FB_LEVEL
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to trigger brake event from specified channel(s).
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_TRIGGER_BRAKE(pwm, u32ChannelMask, u32BrakeType) ((pwm)->SWBRK |= ((u32ChannelMask) << (u32BrakeType)))
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Set Dead zone clock source
|
||
|
|
* @param[in] pwm The pointer of the specified PWM module
|
||
|
|
* @param[in] u32ChannelNum PWM channel number. Valid values are between 0~5
|
||
|
|
* @param[in] u32AfterPrescaler Dead zone clock source is from prescaler output. Valid values are TRUE (after prescaler) or FALSE (before prescaler).
|
||
|
|
* @return None
|
||
|
|
* @details This macro is used to set Dead zone clock source. Every two channels share the same setting.
|
||
|
|
* @note The write-protection function should be disabled before using this function.
|
||
|
|
* @note This function is only supported in M45xD/M45xC.
|
||
|
|
* \hideinitializer
|
||
|
|
*/
|
||
|
|
#define PWM_SET_DEADZONE_CLK_SRC(pwm, u32ChannelNum, u32AfterPrescaler) \
|
||
|
|
((pwm)->DTCTL[(u32ChannelNum) >> 1] = (((pwm)->DTCTL[(u32ChannelNum) >> 1] & ~PWM_DTCTL0_1_DTCKSEL_Msk) | \
|
||
|
|
((u32AfterPrescaler) << PWM_DTCTL0_1_DTCKSEL_Pos)))
|
||
|
|
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
/* Define PWM functions prototype */
|
||
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
||
|
|
uint32_t PWM_ConfigCaptureChannel(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32UnitTimeNsec, uint32_t u32CaptureEdge);
|
||
|
|
uint32_t PWM_ConfigOutputChannel(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Frequency, uint32_t u32DutyCycle);
|
||
|
|
void PWM_Start(PWM_T *pwm, uint32_t u32ChannelMask);
|
||
|
|
void PWM_Stop(PWM_T *pwm, uint32_t u32ChannelMask);
|
||
|
|
void PWM_ForceStop(PWM_T *pwm, uint32_t u32ChannelMask);
|
||
|
|
void PWM_EnableADCTrigger(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Condition);
|
||
|
|
void PWM_DisableADCTrigger(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_ClearADCTriggerFlag(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Condition);
|
||
|
|
uint32_t PWM_GetADCTriggerFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_EnableFaultBrake(PWM_T *pwm, uint32_t u32ChannelMask, uint32_t u32LevelMask, uint32_t u32BrakeSource);
|
||
|
|
void PWM_EnableCapture(PWM_T *pwm, uint32_t u32ChannelMask);
|
||
|
|
void PWM_DisableCapture(PWM_T *pwm, uint32_t u32ChannelMask);
|
||
|
|
void PWM_EnableOutput(PWM_T *pwm, uint32_t u32ChannelMask);
|
||
|
|
void PWM_DisableOutput(PWM_T *pwm, uint32_t u32ChannelMask);
|
||
|
|
void PWM_EnablePDMA(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32RisingFirst, uint32_t u32Mode);
|
||
|
|
void PWM_DisablePDMA(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_EnableDeadZone(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Duration);
|
||
|
|
void PWM_DisableDeadZone(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_EnableCaptureInt(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Edge);
|
||
|
|
void PWM_DisableCaptureInt(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Edge);
|
||
|
|
void PWM_ClearCaptureIntFlag(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Edge);
|
||
|
|
uint32_t PWM_GetCaptureIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_EnableDutyInt(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32IntDutyType);
|
||
|
|
void PWM_DisableDutyInt(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_ClearDutyIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
uint32_t PWM_GetDutyIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_EnableFaultBrakeInt(PWM_T *pwm, uint32_t u32BrakeSource);
|
||
|
|
void PWM_DisableFaultBrakeInt(PWM_T *pwm, uint32_t u32BrakeSource);
|
||
|
|
void PWM_ClearFaultBrakeIntFlag(PWM_T *pwm, uint32_t u32BrakeSource);
|
||
|
|
uint32_t PWM_GetFaultBrakeIntFlag(PWM_T *pwm, uint32_t u32BrakeSource);
|
||
|
|
void PWM_EnablePeriodInt(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32IntPeriodType);
|
||
|
|
void PWM_DisablePeriodInt(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_ClearPeriodIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
uint32_t PWM_GetPeriodIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_EnableZeroInt(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_DisableZeroInt(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_ClearZeroIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
uint32_t PWM_GetZeroIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_EnableLoadMode(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32LoadMode);
|
||
|
|
void PWM_DisableLoadMode(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32LoadMode);
|
||
|
|
void PWM_SetClockSource(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32ClkSrcSel);
|
||
|
|
void PWM_EnableBrakeNoiseFilter(PWM_T *pwm, uint32_t u32BrakePinNum, uint32_t u32ClkCnt, uint32_t u32ClkDivSel);
|
||
|
|
void PWM_DisableBrakeNoiseFilter(PWM_T *pwm, uint32_t u32BrakePinNum);
|
||
|
|
void PWM_EnableBrakePinInverse(PWM_T *pwm, uint32_t u32BrakePinNum);
|
||
|
|
void PWM_DisableBrakePinInverse(PWM_T *pwm, uint32_t u32BrakePinNum);
|
||
|
|
void PWM_SetBrakePinSource(PWM_T *pwm, uint32_t u32BrakePinNum, uint32_t u32SelAnotherModule);
|
||
|
|
uint32_t PWM_GetWrapAroundFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
void PWM_ClearWrapAroundFlag(PWM_T *pwm, uint32_t u32ChannelNum);
|
||
|
|
|
||
|
|
/*@}*/ /* end of group PWM_EXPORTED_FUNCTIONS */
|
||
|
|
|
||
|
|
/*@}*/ /* end of group PWM_Driver */
|
||
|
|
|
||
|
|
/*@}*/ /* end of group Standard_Driver */
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif //__NU_PWM_H__
|
||
|
|
|
||
|
|
/*** (C) COPYRIGHT 2017 Nuvoton Technology Corp. ***/
|