EFM32 Happy Gecko Software Documentation
efm32hg-doc-5.1.2
|
Pulse Counter (PCNT) Peripheral API.
This module contains functions to control the PCNT peripheral of Silicon Labs 32-bit MCUs and SoCs. The PCNT decodes incoming pulses. The module has a quadrature mode which may be used to decode the speed and direction of a mechanical shaft.
Data Structures | |
struct | PCNT_Init_TypeDef |
struct | PCNT_TCC_TypeDef |
Macros | |
#define | PCNT0_CNT_SIZE (16) /* PCNT0 counter is 16 bits. */ |
#define | PCNT_INIT_DEFAULT |
#define | PCNT_TCC_DEFAULT |
Enumerations | |
enum | PCNT_CntEvent_TypeDef { pcntCntEventBoth = _PCNT_CTRL_CNTEV_BOTH, pcntCntEventUp = _PCNT_CTRL_CNTEV_UP, pcntCntEventDown = _PCNT_CTRL_CNTEV_DOWN, pcntCntEventNone = _PCNT_CTRL_CNTEV_NONE } |
enum | PCNT_Mode_TypeDef { pcntModeDisable = _PCNT_CTRL_MODE_DISABLE, pcntModeOvsSingle = _PCNT_CTRL_MODE_OVSSINGLE, pcntModeExtSingle = _PCNT_CTRL_MODE_EXTCLKSINGLE, pcntModeExtQuad = _PCNT_CTRL_MODE_EXTCLKQUAD } |
enum | PCNT_PRSInput_TypeDef { pcntPRSInputS0 = 0, pcntPRSInputS1 = 1 } |
enum | PCNT_PRSSel_TypeDef { pcntPRSCh0 = 0, pcntPRSCh1 = 1, pcntPRSCh2 = 2, pcntPRSCh3 = 3, pcntPRSCh4 = 4, pcntPRSCh5 = 5 } |
enum | PCNT_TCCComp_Typedef { tccCompLTOE = _PCNT_CTRL_TCCCOMP_LTOE, tccCompGTOE = _PCNT_CTRL_TCCCOMP_GTOE, tccCompRange = _PCNT_CTRL_TCCCOMP_RANGE } |
enum | PCNT_TCCMode_TypeDef { tccModeDisabled = _PCNT_CTRL_TCCMODE_DISABLED, tccModeLFA = _PCNT_CTRL_TCCMODE_LFA, tccModePRS = _PCNT_CTRL_TCCMODE_PRS } |
enum | PCNT_TCCPresc_Typedef { tccPrescDiv1 = _PCNT_CTRL_TCCPRESC_DIV1, tccPrescDiv2 = _PCNT_CTRL_TCCPRESC_DIV2, tccPrescDiv4 = _PCNT_CTRL_TCCPRESC_DIV4, tccPrescDiv8 = _PCNT_CTRL_TCCPRESC_DIV8 } |
Functions | |
__STATIC_INLINE uint32_t | PCNT_AuxCounterGet (PCNT_TypeDef *pcnt) |
Get auxiliary counter value. More... | |
__STATIC_INLINE uint32_t | PCNT_CounterGet (PCNT_TypeDef *pcnt) |
Get pulse counter value. More... | |
void | PCNT_CounterReset (PCNT_TypeDef *pcnt) |
Reset PCNT counters and TOP register. More... | |
__STATIC_INLINE void | PCNT_CounterSet (PCNT_TypeDef *pcnt, uint32_t count) |
Set counter value. More... | |
void | PCNT_CounterTopSet (PCNT_TypeDef *pcnt, uint32_t count, uint32_t top) |
Set counter and top values. More... | |
void | PCNT_Enable (PCNT_TypeDef *pcnt, PCNT_Mode_TypeDef mode) |
Set PCNT operational mode. More... | |
void | PCNT_FreezeEnable (PCNT_TypeDef *pcnt, bool enable) |
PCNT register synchronization freeze control. More... | |
void | PCNT_Init (PCNT_TypeDef *pcnt, const PCNT_Init_TypeDef *init) |
Init pulse counter. More... | |
__STATIC_INLINE void | PCNT_IntClear (PCNT_TypeDef *pcnt, uint32_t flags) |
Clear one or more pending PCNT interrupts. More... | |
__STATIC_INLINE void | PCNT_IntDisable (PCNT_TypeDef *pcnt, uint32_t flags) |
Disable one or more PCNT interrupts. More... | |
__STATIC_INLINE void | PCNT_IntEnable (PCNT_TypeDef *pcnt, uint32_t flags) |
Enable one or more PCNT interrupts. More... | |
__STATIC_INLINE uint32_t | PCNT_IntGet (PCNT_TypeDef *pcnt) |
Get pending PCNT interrupt flags. More... | |
__STATIC_INLINE uint32_t | PCNT_IntGetEnabled (PCNT_TypeDef *pcnt) |
Get enabled and pending PCNT interrupt flags. More... | |
__STATIC_INLINE void | PCNT_IntSet (PCNT_TypeDef *pcnt, uint32_t flags) |
Set one or more pending PCNT interrupts from SW. More... | |
void | PCNT_PRSInputEnable (PCNT_TypeDef *pcnt, PCNT_PRSInput_TypeDef prsInput, bool enable) |
Enable/disable the selected PRS input of PCNT. More... | |
void | PCNT_Reset (PCNT_TypeDef *pcnt) |
Reset PCNT to same state as after a HW reset. More... | |
void | PCNT_TCCConfiguration (PCNT_TypeDef *pcnt, const PCNT_TCC_TypeDef *config) |
Set Triggered Compare and Clear configuration. More... | |
__STATIC_INLINE uint32_t | PCNT_TopBufferGet (PCNT_TypeDef *pcnt) |
Get pulse counter top buffer value. More... | |
void | PCNT_TopBufferSet (PCNT_TypeDef *pcnt, uint32_t val) |
Set top buffer value. More... | |
__STATIC_INLINE uint32_t | PCNT_TopGet (PCNT_TypeDef *pcnt) |
Get pulse counter top value. More... | |
void | PCNT_TopSet (PCNT_TypeDef *pcnt, uint32_t val) |
Set top value. More... | |
#define PCNT0_CNT_SIZE (16) /* PCNT0 counter is 16 bits. */ |
PCNT0 Counter register size.
Definition at line 62 of file em_pcnt.h.
Referenced by PCNT_CounterTopSet(), PCNT_Init(), and PCNT_TopSet().
#define PCNT_INIT_DEFAULT |
Default config for PCNT init structure.
#define PCNT_TCC_DEFAULT |
Counter event selection. Note: unshifted values are being used for enumeration because multiple configuration structure members use this type definition.
enum PCNT_Mode_TypeDef |
Mode selection.
enum PCNT_PRSSel_TypeDef |
enum PCNT_TCCComp_Typedef |
Compare modes for TCC module
enum PCNT_TCCMode_TypeDef |
Default config for PCNT init structure. Modes for Triggered Compare and Clear module
Prescaler values for LFA compare and clear events. Only has effect when TCC mode is LFA.
__STATIC_INLINE uint32_t PCNT_AuxCounterGet | ( | PCNT_TypeDef * | pcnt | ) |
Get auxiliary counter value.
[in] | pcnt | Pointer to PCNT peripheral register block. |
Definition at line 401 of file em_pcnt.h.
References PCNT_TypeDef::AUXCNT.
__STATIC_INLINE uint32_t PCNT_CounterGet | ( | PCNT_TypeDef * | pcnt | ) |
Get pulse counter value.
[in] | pcnt | Pointer to PCNT peripheral register block. |
Definition at line 385 of file em_pcnt.h.
References PCNT_TypeDef::CNT.
void PCNT_CounterReset | ( | PCNT_TypeDef * | pcnt | ) |
Reset PCNT counters and TOP register.
[in] | pcnt | Pointer to PCNT peripheral register block. |
Definition at line 146 of file em_pcnt.c.
References _PCNT_CTRL_RSTEN_SHIFT, BUS_RegBitWrite(), and PCNT_TypeDef::CTRL.
__STATIC_INLINE void PCNT_CounterSet | ( | PCNT_TypeDef * | pcnt, |
uint32_t | count | ||
) |
Set counter value.
The pulse counter is disabled while changing counter value, and reenabled (if originally enabled) when counter value has been set.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | count | Value to set in counter register. |
Definition at line 431 of file em_pcnt.h.
References PCNT_CounterTopSet(), and PCNT_TypeDef::TOP.
void PCNT_CounterTopSet | ( | PCNT_TypeDef * | pcnt, |
uint32_t | count, | ||
uint32_t | top | ||
) |
Set counter and top values.
The pulse counter is disabled while changing these values, and reenabled (if originally enabled) when values have been set.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | count | Value to set in counter register. |
[in] | top | Value to set in top register. |
Definition at line 182 of file em_pcnt.c.
References _PCNT_CTRL_MODE_MASK, PCNT_TypeDef::CMD, PCNT_TypeDef::CTRL, PCNT0, PCNT0_CNT_SIZE, PCNT_CMD_LCNTIM, PCNT_CMD_LTOPBIM, PCNT_CTRL_MODE_DISABLE, PCNT_SYNCBUSY_CMD, PCNT_SYNCBUSY_CTRL, PCNT_SYNCBUSY_TOPB, and PCNT_TypeDef::TOPB.
Referenced by PCNT_CounterSet(), and PCNT_Init().
void PCNT_Enable | ( | PCNT_TypeDef * | pcnt, |
PCNT_Mode_TypeDef | mode | ||
) |
Set PCNT operational mode.
Notice that this function does not do any configuration. Setting operational mode is normally only required after initialization is done, and if not done as part of initialization. Or if requiring to disable/reenable pulse counter.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | mode | Operational mode to use for PCNT. |
Definition at line 284 of file em_pcnt.c.
References _PCNT_CTRL_MODE_MASK, _PCNT_CTRL_MODE_SHIFT, PCNT_TypeDef::CTRL, and PCNT_SYNCBUSY_CTRL.
void PCNT_FreezeEnable | ( | PCNT_TypeDef * | pcnt, |
bool | enable | ||
) |
PCNT register synchronization freeze control.
Some PCNT registers require synchronization into the low frequency (LF) domain. The freeze feature allows for several such registers to be modified before passing them to the LF domain simultaneously (which takes place when the freeze mode is disabled).
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | enable |
|
Definition at line 371 of file em_pcnt.c.
References PCNT_TypeDef::FREEZE, PCNT_FREEZE_REGFREEZE, and PCNT_TypeDef::SYNCBUSY.
void PCNT_Init | ( | PCNT_TypeDef * | pcnt, |
const PCNT_Init_TypeDef * | init | ||
) |
Init pulse counter.
This function will configure the pulse counter. The clock selection is configured as follows, depending on operational mode:
Notice that the LFACLK must be enabled in all modes, since some basic setup is done with this clock even if external pin clock usage mode is chosen. The pulse counter clock for the selected instance must also be enabled prior to init.
Notice that pins used by the PCNT module must be properly configured by the user explicitly through setting the ROUTE register, in order for the PCNT to work as intended.
Writing to CNT will not occur in external clock modes (EXTCLKQUAD and EXTCLKSINGLE) because the external clock rate is unknown. The user should handle it manually depending on the application
TOPB is written for all modes but in external clock mode it will take 3 external clock cycles to sync to TOP
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | init | Pointer to initialization structure used to initialize. |
Definition at line 435 of file em_pcnt.c.
References _PCNT_CTRL_AUXCNTEV_SHIFT, _PCNT_CTRL_CNTEV_SHIFT, _PCNT_CTRL_MODE_MASK, _PCNT_CTRL_MODE_SHIFT, _PCNT_CTRL_RSTEN_SHIFT, _PCNT_INPUT_S0PRSSEL_MASK, _PCNT_INPUT_S0PRSSEL_SHIFT, _PCNT_INPUT_S1PRSSEL_MASK, _PCNT_INPUT_S1PRSSEL_SHIFT, PCNT_Init_TypeDef::auxCntEvent, BUS_RegBitWrite(), PCNT_TypeDef::CMD, CMU_PCNTClockExternalSet(), PCNT_Init_TypeDef::cntEvent, PCNT_Init_TypeDef::countDown, PCNT_Init_TypeDef::counter, PCNT_TypeDef::CTRL, PCNT_Init_TypeDef::filter, PCNT_Init_TypeDef::hyst, PCNT_TypeDef::INPUT, PCNT_Init_TypeDef::mode, PCNT_Init_TypeDef::negEdge, PCNT0, PCNT0_CNT_SIZE, PCNT_CMD_LTOPBIM, PCNT_CounterTopSet(), PCNT_CTRL_CNTDIR_DOWN, PCNT_CTRL_EDGE_NEG, PCNT_CTRL_FILT, PCNT_CTRL_HYST, PCNT_CTRL_MODE_DISABLE, PCNT_CTRL_RSTEN, PCNT_CTRL_S1CDIR, PCNT_SYNCBUSY_CTRL, pcntCntEventBoth, pcntCntEventDown, pcntCntEventNone, pcntCntEventUp, pcntModeExtQuad, pcntModeExtSingle, pcntModeOvsSingle, PCNT_Init_TypeDef::s0PRS, PCNT_Init_TypeDef::s1CntDir, PCNT_Init_TypeDef::s1PRS, PCNT_Init_TypeDef::top, and PCNT_TypeDef::TOPB.
__STATIC_INLINE void PCNT_IntClear | ( | PCNT_TypeDef * | pcnt, |
uint32_t | flags | ||
) |
Clear one or more pending PCNT interrupts.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | flags | Pending PCNT interrupt source to clear. Use a bitwise logic OR combination of valid interrupt flags for the PCNT module (PCNT_IF_nnn). |
Definition at line 464 of file em_pcnt.h.
References PCNT_TypeDef::IFC.
__STATIC_INLINE void PCNT_IntDisable | ( | PCNT_TypeDef * | pcnt, |
uint32_t | flags | ||
) |
Disable one or more PCNT interrupts.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | flags | PCNT interrupt sources to disable. Use a bitwise logic OR combination of valid interrupt flags for the PCNT module (PCNT_IF_nnn). |
Definition at line 480 of file em_pcnt.h.
References PCNT_TypeDef::IEN.
__STATIC_INLINE void PCNT_IntEnable | ( | PCNT_TypeDef * | pcnt, |
uint32_t | flags | ||
) |
Enable one or more PCNT interrupts.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | flags | PCNT interrupt sources to enable. Use a bitwise logic OR combination of valid interrupt flags for the PCNT module (PCNT_IF_nnn). |
Definition at line 501 of file em_pcnt.h.
References PCNT_TypeDef::IEN.
__STATIC_INLINE uint32_t PCNT_IntGet | ( | PCNT_TypeDef * | pcnt | ) |
Get pending PCNT interrupt flags.
[in] | pcnt | Pointer to PCNT peripheral register block. |
Definition at line 520 of file em_pcnt.h.
References PCNT_TypeDef::IF.
__STATIC_INLINE uint32_t PCNT_IntGetEnabled | ( | PCNT_TypeDef * | pcnt | ) |
Get enabled and pending PCNT interrupt flags.
Useful for handling more interrupt sources in the same interrupt handler.
[in] | pcnt | Pointer to PCNT peripheral register block. |
Definition at line 546 of file em_pcnt.h.
References PCNT_TypeDef::IEN, and PCNT_TypeDef::IF.
__STATIC_INLINE void PCNT_IntSet | ( | PCNT_TypeDef * | pcnt, |
uint32_t | flags | ||
) |
Set one or more pending PCNT interrupts from SW.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | flags | PCNT interrupt sources to set to pending. Use a bitwise logic OR combination of valid interrupt flags for the PCNT module (PCNT_IF_nnn). |
Definition at line 570 of file em_pcnt.h.
References PCNT_TypeDef::IFS.
void PCNT_PRSInputEnable | ( | PCNT_TypeDef * | pcnt, |
PCNT_PRSInput_TypeDef | prsInput, | ||
bool | enable | ||
) |
Enable/disable the selected PRS input of PCNT.
Notice that this function does not do any configuration.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | prsInput | PRS input (S0 or S1) of the selected PCNT module. |
[in] | enable | Set to true to enable, false to disable the selected PRS input. |
Definition at line 316 of file em_pcnt.c.
References _PCNT_INPUT_S0PRSEN_SHIFT, _PCNT_INPUT_S1PRSEN_SHIFT, BUS_RegBitWrite(), PCNT_TypeDef::INPUT, and pcntPRSInputS1.
void PCNT_Reset | ( | PCNT_TypeDef * | pcnt | ) |
Reset PCNT to same state as after a HW reset.
Notice the LFACLK must be enabled, since some basic reset is done with this clock. The pulse counter clock for the selected instance must also be enabled prior to init.
[in] | pcnt | Pointer to PCNT peripheral register block. |
Definition at line 644 of file em_pcnt.c.
References _PCNT_CTRL_RESETVALUE, _PCNT_CTRL_RSTEN_SHIFT, _PCNT_IEN_RESETVALUE, _PCNT_IFC_MASK, _PCNT_TOPB_RESETVALUE, BUS_RegBitWrite(), CMU_PCNTClockExternalSet(), PCNT_TypeDef::CTRL, PCNT_TypeDef::IEN, PCNT_TypeDef::IFC, PCNT_CTRL_RSTEN, PCNT_SYNCBUSY_CTRL, and PCNT_TopBufferSet().
void PCNT_TCCConfiguration | ( | PCNT_TypeDef * | pcnt, |
const PCNT_TCC_TypeDef * | config | ||
) |
Set Triggered Compare and Clear configuration.
This function will configure the PCNT TCC (Triggered Compare and Clear) module. This module can, upon a configurable trigger source, compare the current counter value with the configured TOP value. Upon match, the counter will be reset, and the TCC PRS output and TCC interrupt flag will be set.
Since there is a comparison with the TOP value, the counter will not stop counting nor wrap when hitting the TOP value, but it will keep on counting until its maximum value. Then, it will not wrap, but instead stop counting and set the overflow flag.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | config | Pointer to configuration structure to be applied. |
Definition at line 747 of file em_pcnt.c.
References _PCNT_CTRL_PRSGATEEN_MASK, _PCNT_CTRL_PRSGATEEN_SHIFT, _PCNT_CTRL_TCCCOMP_MASK, _PCNT_CTRL_TCCCOMP_SHIFT, _PCNT_CTRL_TCCMODE_MASK, _PCNT_CTRL_TCCMODE_SHIFT, _PCNT_CTRL_TCCPRESC_MASK, _PCNT_CTRL_TCCPRESC_SHIFT, _PCNT_CTRL_TCCPRSPOL_MASK, _PCNT_CTRL_TCCPRSPOL_SHIFT, _PCNT_CTRL_TCCPRSSEL_MASK, _PCNT_CTRL_TCCPRSSEL_SHIFT, PCNT_TCC_TypeDef::compare, PCNT_TypeDef::CTRL, PCNT_TCC_TypeDef::mode, PCNT_SYNCBUSY_CTRL, PCNT_TCC_TypeDef::prescaler, PCNT_TCC_TypeDef::prsGateEnable, PCNT_TCC_TypeDef::prsPolarity, and PCNT_TCC_TypeDef::tccPRS.
__STATIC_INLINE uint32_t PCNT_TopBufferGet | ( | PCNT_TypeDef * | pcnt | ) |
Get pulse counter top buffer value.
[in] | pcnt | Pointer to PCNT peripheral register block. |
Definition at line 587 of file em_pcnt.h.
References PCNT_TypeDef::TOPB.
void PCNT_TopBufferSet | ( | PCNT_TypeDef * | pcnt, |
uint32_t | val | ||
) |
Set top buffer value.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | val | Value to set in top buffer register. |
Definition at line 788 of file em_pcnt.c.
References PCNT_SYNCBUSY_TOPB, and PCNT_TypeDef::TOPB.
Referenced by PCNT_Reset().
__STATIC_INLINE uint32_t PCNT_TopGet | ( | PCNT_TypeDef * | pcnt | ) |
Get pulse counter top value.
[in] | pcnt | Pointer to PCNT peripheral register block. |
Definition at line 604 of file em_pcnt.h.
References PCNT_TypeDef::TOP.
void PCNT_TopSet | ( | PCNT_TypeDef * | pcnt, |
uint32_t | val | ||
) |
Set top value.
[in] | pcnt | Pointer to PCNT peripheral register block. |
[in] | val | Value to set in top register. |
Definition at line 814 of file em_pcnt.c.
References PCNT_TypeDef::CMD, PCNT0, PCNT0_CNT_SIZE, PCNT_CMD_LTOPBIM, PCNT_SYNCBUSY_CMD, PCNT_SYNCBUSY_TOPB, and PCNT_TypeDef::TOPB.