| MINI55_BSP V3.02.004 The Board Support Package for Mini55 Series MCU

pwm.h
Go to the documentation of this file.
1/**************************************************************************/
12#ifndef __PWM_H__
13#define __PWM_H__
14
15#ifdef __cplusplus
16 extern "C"
17{
18#endif
19
20
32#define PWM_CHANNEL_NUM (6)
33#define PWM_CLK_DIV_1 (4UL)
34#define PWM_CLK_DIV_2 (0UL)
35#define PWM_CLK_DIV_4 (1UL)
36#define PWM_CLK_DIV_8 (2UL)
37#define PWM_CLK_DIV_16 (3UL)
38#define PWM_EDGE_ALIGNED (0UL)
39#define PWM_CENTER_ALIGNED (PWM_CTL_CNTTYPE_Msk)
40#define PWM_TRIGGER_ADC_CNTR_IS_0 PWM_ADCTCTL0_ZPTRGEN0_Msk
41#define PWM_TRIGGER_ADC_CNTR_IS_CMR_D PWM_ADCTCTL0_CDTRGEN0_Msk
42#define PWM_TRIGGER_ADC_CNTR_IS_CNR PWM_ADCTCTL0_CPTRGEN0_Msk
43#define PWM_TRIGGER_ADC_CNTR_IS_CMR_U PWM_ADCTCTL0_CUTRGEN0_Msk
44#define PWM_FB0_EINT0 (PWM_BRKCTL_BRK0EN_Msk)
45#define PWM_FB0_ACMP1 (PWM_BRKCTL_BRK0EN_Msk | PWM_BRKCTL_BRK1SEL_Msk)
46#define PWM_FB1_EINT1 (PWM_BRKCTL_BRK1EN_Msk)
47#define PWM_FB1_ACMP0 (PWM_BRKCTL_BRK1EN_Msk | PWM_BRKCTL_BRK0SEL_Msk)
48#define PWM_PERIOD_INT_UNDERFLOW (0)
49#define PWM_PERIOD_INT_MATCH_CNR (PWM_INTEN_PINTTYPE_Msk)
50/*---------------------------------------------------------------------------------------------------------*/
51/* PWM Group channel number constants definitions */
52/*---------------------------------------------------------------------------------------------------------*/
53#define PWM_CH0 0x0
54#define PWM_CH1 0x1
55#define PWM_CH2 0x2
56#define PWM_CH3 0x3
57#define PWM_CH4 0x4
58#define PWM_CH5 0x5 /* end of group MINI55_PWM_EXPORTED_CONSTANTS */
60
61
72#define PWM_ENABLE_COMPLEMENTARY_MODE(pwm) (PWM->CTL = (PWM->CTL & ~PWM_CTL_MODE_Msk) |(1UL << PWM_CTL_MODE_Pos))
73
80#define PWM_DISABLE_COMPLEMENTARY_MODE(pwm) (PWM->CTL &= ~PWM_CTL_MODE_Msk)
81
88#define PWM_ENABLE_GROUP_MODE(pwm) (PWM->CTL |= PWM_CTL_GROUPEN_Msk)
89
96#define PWM_DISABLE_GROUP_MODE(pwm) (PWM->CTL &= ~PWM_CTL_GROUPEN_Msk)
97
104#define PWM_ENABLE_SYNC_MODE(pwm) (PWM->CTL = (PWM->CTL & ~PWM_CTL_MODE_Msk) |(2UL << PWM_CTL_MODE_Pos))
105
112#define PWM_DISABLE_SYNC_MODE(pwm) (PWM->CTL &= ~PWM_CTL_MODE_Msk)
113
122#define PWM_ENABLE_OUTPUT_INVERTER(pwm, u32ChannelMask) \
123 do{ \
124 int i;\
125 (pwm)->CTL &= ~(PWM_CTL_PINV0_Msk|PWM_CTL_PINV1_Msk|PWM_CTL_PINV2_Msk|PWM_CTL_PINV3_Msk|PWM_CTL_PINV4_Msk|PWM_CTL_PINV5_Msk);\
126 for(i = 0; i < 6; i++) { \
127 if((u32ChannelMask) & (1 << i)) \
128 (pwm)->CTL |= (1 << (PWM_CTL_PINV0_Pos + (i * 4))); \
129 } \
130 }while(0)
131
142#define PWM_SET_PRESCALER(pwm, u32ChannelNum, u32Prescaler) \
143 (PWM->CLKPSC = (PWM->CLKPSC & ~(PWM_CLKPSC_CLKPSC01_Msk << (((u32ChannelNum) >> 1) * 8))) | ((u32Prescaler) << (((u32ChannelNum) >> 1) * 8)))
144
158#define PWM_SET_DIVIDER(pwm, u32ChannelNum, u32Divider) \
159 (PWM->CLKDIV = (PWM->CLKDIV & ~(PWM_CLKDIV_CLKDIV0_Msk << ((u32ChannelNum) * 4))) | ((u32Divider) << ((u32ChannelNum) * 4)))
160
170#define PWM_SET_CMR(pwm, u32ChannelNum, u32CMR) (PWM->CMPDAT[u32ChannelNum] = (u32CMR))
171
182#define PWM_SET_CNR(pwm, u32ChannelNum, u32CNR) (PWM->PERIOD[u32ChannelNum] = (u32CNR))
183
194#define PWM_SET_ALIGNED_TYPE(pwm, u32ChannelMask, u32AlignedType) \
195 (PWM->CTL = (PWM->CTL & ~PWM_CTL_CNTTYPE_Msk) | (u32AlignedType))
196
197
198uint32_t PWM_ConfigOutputChannel(PWM_T *pwm,
199 uint32_t u32ChannelNum,
200 uint32_t u32Frequency,
201 uint32_t u32DutyCycle);
202 void PWM_Start(PWM_T *pwm, uint32_t u32ChannelMask);
203 void PWM_Stop(PWM_T *pwm, uint32_t u32ChannelMask);
204 void PWM_ForceStop(PWM_T *pwm, uint32_t u32ChannelMask);
205 void PWM_EnableADCTrigger(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Condition);
206 void PWM_DisableADCTrigger(PWM_T *pwm, uint32_t u32ChannelNum);
207 void PWM_ClearADCTriggerFlag(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Condition);
208uint32_t PWM_GetADCTriggerFlag (PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Condition);
209 void PWM_EnableFaultBrake(PWM_T *pwm,
210 uint32_t u32ChannelMask,
211 uint32_t u32LevelMask,
212 uint32_t u32BrakeSource);
213 void PWM_ClearFaultBrakeFlag(PWM_T *pwm, uint32_t u32BrakeSource);
214 void PWM_EnableOutput(PWM_T *pwm, uint32_t u32ChannelMask);
215 void PWM_DisableOutput(PWM_T *pwm, uint32_t u32ChannelMask);
216 void PWM_EnableDeadZone(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Duration);
217 void PWM_DisableDeadZone(PWM_T *pwm, uint32_t u32ChannelNum);
218 void PWM_EnableDutyInt(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32IntDutyType);
219 void PWM_DisableDutyInt(PWM_T *pwm, uint32_t u32ChannelNum);
220 void PWM_ClearDutyIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
221uint32_t PWM_GetDutyIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
222 void PWM_EnableFaultBrakeInt(PWM_T *pwm, uint32_t u32BrakeSource);
223 void PWM_DisableFaultBrakeInt(PWM_T *pwm, uint32_t u32BrakeSource);
224 void PWM_ClearFaultBrakeIntFlag(PWM_T *pwm, uint32_t u32BrakeSource);
225uint32_t PWM_GetFaultBrakeIntFlag(PWM_T *pwm, uint32_t u32BrakeSource);
226
227 void PWM_EnablePeriodInt (PWM_T *pwm, uint32_t u32ChannelNum);
228 void PWM_DisablePeriodInt(PWM_T *pwm, uint32_t u32ChannelNum);
229 void PWM_ClearPeriodIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
230uint32_t PWM_GetPeriodIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
231
232 void PWM_EnableCenterInt(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32IntPeriodType);
233 void PWM_DisableCenterInt(PWM_T *pwm, uint32_t u32ChannelNum);
234 void PWM_ClearCenterIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
235uint32_t PWM_GetCenterIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
236
237 void PWM_EnableRiseInt(PWM_T *pwm, uint32_t u32ChannelNum);
238 void PWM_DisableRiseInt(PWM_T *pwm, uint32_t u32ChannelNum);
239 void PWM_ClearRiseIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
240uint32_t PWM_GetRiseIntFlag(PWM_T *pwm, uint32_t u32ChannelNum);
241 /* end of group MINI55_PWM_EXPORTED_FUNCTIONS */
243 /* end of group MINI55_PWM_Driver */
245 /* end of group MINI55_Device_Driver */
247
248#ifdef __cplusplus
249}
250#endif
251
252#endif //__PWM_H__
253
254/*** (C) COPYRIGHT 2014 Nuvoton Technology Corp. ***/
PWM_ForceStop
void PWM_ForceStop(PWM_T *pwm, uint32_t u32ChannelMask)
This function stop PWM generation immediately by clear channel enable bit.
Definition: pwm.c:151
PWM_Stop
void PWM_Stop(PWM_T *pwm, uint32_t u32ChannelMask)
This function stop PWM module.
Definition: pwm.c:131
PWM_EnableDeadZone
void PWM_EnableDeadZone(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Duration)
This function enable Dead zone of selected channel.
Definition: pwm.c:327
PWM_ClearADCTriggerFlag
void PWM_ClearADCTriggerFlag(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Condition)
This function clear selected channel trigger ADC flag.
Definition: pwm.c:230
PWM_DisableADCTrigger
void PWM_DisableADCTrigger(PWM_T *pwm, uint32_t u32ChannelNum)
This function disable selected channel to trigger ADC.
Definition: pwm.c:201
PWM_DisableRiseInt
void PWM_DisableRiseInt(PWM_T *pwm, uint32_t u32ChannelNum)
This function disable Rise interrupt of selected channel.
Definition: pwm.c:461
PWM_ClearRiseIntFlag
void PWM_ClearRiseIntFlag(PWM_T *pwm, uint32_t u32ChannelNum)
This function clears Rise interrupt flag of selected channel.
Definition: pwm.c:472
PWM_DisablePeriodInt
void PWM_DisablePeriodInt(PWM_T *pwm, uint32_t u32ChannelNum)
This function disable Period interrupt of selected channel.
Definition: pwm.c:415
PWM_EnableDutyInt
void PWM_EnableDutyInt(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32IntDutyType)
This function enable duty interrupt of selected channel.
Definition: pwm.c:358
PWM_GetFaultBrakeIntFlag
uint32_t PWM_GetFaultBrakeIntFlag(PWM_T *pwm, uint32_t u32BrakeSource)
This function get fault brake interrupt of selected source.
Definition: pwm.c:535
PWM_DisableFaultBrakeInt
void PWM_DisableFaultBrakeInt(PWM_T *pwm, uint32_t u32BrakeSource)
This function disable fault brake interrupt.
Definition: pwm.c:507
PWM_ConfigOutputChannel
uint32_t PWM_ConfigOutputChannel(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Frequency, uint32_t u32DutyCycle)
This function config PWM generator and get the nearest frequency in edge aligned auto-reload mode.
Definition: pwm.c:37
PWM_EnablePeriodInt
void PWM_EnablePeriodInt(PWM_T *pwm, uint32_t u32ChannelNum)
This function enable Period interrupt of selected channel.
Definition: pwm.c:404
PWM_DisableCenterInt
void PWM_DisableCenterInt(PWM_T *pwm, uint32_t u32ChannelNum)
This function disable Central interrupt of selected channel.
Definition: pwm.c:561
PWM_EnableRiseInt
void PWM_EnableRiseInt(PWM_T *pwm, uint32_t u32ChannelNum)
This function enable Rise interrupt of selected channel.
Definition: pwm.c:450
PWM_DisableDutyInt
void PWM_DisableDutyInt(PWM_T *pwm, uint32_t u32ChannelNum)
This function disable duty interrupt of selected channel.
Definition: pwm.c:369
PWM_GetADCTriggerFlag
uint32_t PWM_GetADCTriggerFlag(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Condition)
This function get selected channel trigger ADC flag.
Definition: pwm.c:249
PWM_ClearDutyIntFlag
void PWM_ClearDutyIntFlag(PWM_T *pwm, uint32_t u32ChannelNum)
This function clears duty interrupt flag of selected channel.
Definition: pwm.c:380
PWM_EnableFaultBrake
void PWM_EnableFaultBrake(PWM_T *pwm, uint32_t u32ChannelMask, uint32_t u32LevelMask, uint32_t u32BrakeSource)
This function enable fault brake of selected channels.
Definition: pwm.c:275
PWM_GetDutyIntFlag
uint32_t PWM_GetDutyIntFlag(PWM_T *pwm, uint32_t u32ChannelNum)
This function get duty interrupt flag of selected channel.
Definition: pwm.c:393
PWM_DisableDeadZone
void PWM_DisableDeadZone(PWM_T *pwm, uint32_t u32ChannelNum)
This function disable Dead zone of selected channel.
Definition: pwm.c:343
PWM_DisableOutput
void PWM_DisableOutput(PWM_T *pwm, uint32_t u32ChannelMask)
This function disables PWM output generation of selected channels.
Definition: pwm.c:314
PWM_EnableCenterInt
void PWM_EnableCenterInt(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32IntPeriodType)
This function enable Central interrupt of selected channel.
Definition: pwm.c:550
PWM_ClearCenterIntFlag
void PWM_ClearCenterIntFlag(PWM_T *pwm, uint32_t u32ChannelNum)
This function clear Central interrupt of selected channel.
Definition: pwm.c:572
PWM_GetRiseIntFlag
uint32_t PWM_GetRiseIntFlag(PWM_T *pwm, uint32_t u32ChannelNum)
This function get Rise interrupt flag of selected channel.
Definition: pwm.c:485
PWM_ClearFaultBrakeIntFlag
void PWM_ClearFaultBrakeIntFlag(PWM_T *pwm, uint32_t u32BrakeSource)
This function clear fault brake interrupt of selected source.
Definition: pwm.c:520
PWM_Start
void PWM_Start(PWM_T *pwm, uint32_t u32ChannelMask)
This function start PWM module.
Definition: pwm.c:110
PWM_ClearPeriodIntFlag
void PWM_ClearPeriodIntFlag(PWM_T *pwm, uint32_t u32ChannelNum)
This function clears Period interrupt flag of selected channel.
Definition: pwm.c:426
PWM_EnableOutput
void PWM_EnableOutput(PWM_T *pwm, uint32_t u32ChannelMask)
This function enables PWM output generation of selected channels.
Definition: pwm.c:302
PWM_EnableFaultBrakeInt
void PWM_EnableFaultBrakeInt(PWM_T *pwm, uint32_t u32BrakeSource)
This function enable fault brake interrupt.
Definition: pwm.c:496
PWM_GetPeriodIntFlag
uint32_t PWM_GetPeriodIntFlag(PWM_T *pwm, uint32_t u32ChannelNum)
This function get Period interrupt flag of selected channel.
Definition: pwm.c:439
PWM_ClearFaultBrakeFlag
void PWM_ClearFaultBrakeFlag(PWM_T *pwm, uint32_t u32BrakeSource)
This function clear fault brake flag.
Definition: pwm.c:290
PWM_GetCenterIntFlag
uint32_t PWM_GetCenterIntFlag(PWM_T *pwm, uint32_t u32ChannelNum)
This function get Central interrupt of selected channel.
Definition: pwm.c:585
PWM_EnableADCTrigger
void PWM_EnableADCTrigger(PWM_T *pwm, uint32_t u32ChannelNum, uint32_t u32Condition)
This function enable selected channel to trigger ADC.
Definition: pwm.c:176
PWM_T
Definition: Mini55Series.h:2878