PCNT - Pulse Counter#

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.

Modules#

PCNT_Init_TypeDef

Enumerations#

enum
pcntModeDisable = _PCNT_CTRL_MODE_DISABLE
pcntModeOvsSingle = _PCNT_CTRL_MODE_OVSSINGLE
pcntModeExtSingle = _PCNT_CTRL_MODE_EXTCLKSINGLE
pcntModeExtQuad = _PCNT_CTRL_MODE_EXTCLKQUAD
}

Mode selection.

Functions#

void
PCNT_CounterReset(PCNT_TypeDef *pcnt)

Reset PCNT counters and TOP register.

void
PCNT_Enable(PCNT_TypeDef *pcnt, PCNT_Mode_TypeDef mode)

Set PCNT operational mode.

bool
PCNT_IsEnabled(PCNT_TypeDef *pcnt)

Returns if the PCNT module is enabled or not.

void
PCNT_CounterTopSet(PCNT_TypeDef *pcnt, uint32_t count, uint32_t top)

Set the counter and top values.

void
PCNT_FreezeEnable(PCNT_TypeDef *pcnt, bool enable)

PCNT register synchronization freeze control.

void
PCNT_Init(PCNT_TypeDef *pcnt, const PCNT_Init_TypeDef *init)

Initialize the pulse counter.

void
PCNT_Reset(PCNT_TypeDef *pcnt)

Reset PCNT to the same state that it was in after a hardware reset.

void
PCNT_TopBufferSet(PCNT_TypeDef *pcnt, uint32_t val)

Set top buffer value.

void
PCNT_TopSet(PCNT_TypeDef *pcnt, uint32_t val)

Set the top value.

uint32_t
PCNT_CounterGet(PCNT_TypeDef *pcnt)

Default configuration for PCNT initialization structure.

void
PCNT_CounterSet(PCNT_TypeDef *pcnt, uint32_t count)

Set a counter value.

void
PCNT_IntClear(PCNT_TypeDef *pcnt, uint32_t flags)

Clear one or more pending PCNT interrupts.

void
PCNT_IntDisable(PCNT_TypeDef *pcnt, uint32_t flags)

Disable one or more PCNT interrupts.

void
PCNT_IntEnable(PCNT_TypeDef *pcnt, uint32_t flags)

Enable one or more PCNT interrupts.

uint32_t
PCNT_IntGet(PCNT_TypeDef *pcnt)

Get pending PCNT interrupt flags.

uint32_t
PCNT_IntGetEnabled(PCNT_TypeDef *pcnt)

Get enabled and pending PCNT interrupt flags.

void
PCNT_IntSet(PCNT_TypeDef *pcnt, uint32_t flags)

Set one or more pending PCNT interrupts from SW.

uint32_t
PCNT_TopBufferGet(PCNT_TypeDef *pcnt)

Get the pulse counter top buffer value.

uint32_t
PCNT_TopGet(PCNT_TypeDef *pcnt)

Get the pulse counter top value.

void
PCNT_Sync(PCNT_TypeDef *pcnt, uint32_t mask)

Wait for an ongoing sync of register(s) to low-frequency domain to complete.

Macros#

#define

PCNT0 Counter register size.

#define

PCNT1 Counter register size.

#define

PCNT2 Counter register size.

#define

PCNT mode disable.

#define

PCNT count event is none.

#define

Default Debug.

#define
DEFAULT_MODE pcntModeDisable,

Default Mode.

#define

Default Hysteresis.

#define

Default counter direction.

#define

Default count event.

#define

Default auxiliary count event.

#define

Default selected PRS channel as S0IN and S1IN.

#define

Default configuration for PCNT initialization structure.

Enumeration Documentation#

PCNT_Mode_TypeDef#

PCNT_Mode_TypeDef

Mode selection.

Enumerator
pcntModeDisable

Disable pulse counter.

pcntModeOvsSingle

Single input LFACLK oversampling mode (available in EM0-EM2).

pcntModeExtSingle

Externally clocked single input counter mode (available in EM0-EM3).

pcntModeExtQuad

Externally clocked quadrature decoder mode (available in EM0-EM3).


Definition at line 88 of file platform/emlib/inc/em_pcnt.h

Function Documentation#

PCNT_CounterReset#

void PCNT_CounterReset (PCNT_TypeDef * pcnt)

Reset PCNT counters and TOP register.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

Note

  • Notice that special SYNCBUSY handling is not applicable for the RSTEN bit of the control register, so we don't need to wait for it when only modifying RSTEN. (It would mean undefined wait time if clocked by an external clock.) The SYNCBUSY bit will however be set, leading to a synchronization in the LF domain, with, in reality, no changes.


Definition at line 119 of file platform/emlib/src/em_pcnt.c

PCNT_Enable#

void PCNT_Enable (PCNT_TypeDef * pcnt, PCNT_Mode_TypeDef mode)

Set PCNT operational mode.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

[in]mode

An operational mode to use for PCNT.

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.

Note

  • This function may stall until synchronization to low-frequency domain is completed. For that reason, it should normally not be used when an external clock is used for the PCNT module, since stall time may be undefined.


Definition at line 160 of file platform/emlib/src/em_pcnt.c

PCNT_IsEnabled#

bool PCNT_IsEnabled (PCNT_TypeDef * pcnt)

Returns if the PCNT module is enabled or not.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

Notice that this function does not do any configuration.

Returns

  • Returns TRUE if the module is enabled.


Definition at line 221 of file platform/emlib/src/em_pcnt.c

PCNT_CounterTopSet#

void PCNT_CounterTopSet (PCNT_TypeDef * pcnt, uint32_t count, uint32_t top)

Set the counter and top values.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

[in]count

A value to set in the counter register.

[in]top

A value to set in the top register.

The pulse counter is disabled while changing these values and reenabled (if originally enabled) when values have been set.

Note

  • This function will stall until synchronization to low-frequency domain is completed. For that reason, it should normally not be used when an external clock is used for the PCNT module, since stall time may be undefined. The counter should normally only be set when operating in (or about to enable) pcntModeOvsSingle mode.


Definition at line 256 of file platform/emlib/src/em_pcnt.c

PCNT_FreezeEnable#

void PCNT_FreezeEnable (PCNT_TypeDef * pcnt, bool enable)

PCNT register synchronization freeze control.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

[in]enable
  • True - enable freeze, modified registers are not propagated to the LF domain.

  • False - disables freeze, modified registers are propagated to LF domain.

Some PCNT registers require synchronization into the low-frequency (LF) domain. The freeze feature allows for several registers to be modified before passing them to the LF domain simultaneously, which takes place when the freeze mode is disabled.

Note

  • When enabling freeze mode, this function will wait for all current ongoing PCNT synchronization to the LF domain to complete (normally synchronization will not be in progress). However, for this reason, when using freeze mode, modifications of registers requiring the LF synchronization should be done within one freeze enable/disable block to avoid unnecessary stalling.


Definition at line 451 of file platform/emlib/src/em_pcnt.c

PCNT_Init#

void PCNT_Init (PCNT_TypeDef * pcnt, const PCNT_Init_TypeDef * init)

Initialize the pulse counter.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

[in]init

A pointer to the initialization structure.

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 the external pin clock usage mode is chosen. The pulse counter clock for the selected instance must also be enabled prior to initialization.

Notice that pins used by the PCNT module must be properly configured by the user explicitly through setting the ROUTE register 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.

Note

  • Initializing requires synchronization into the low-frequency domain. This may cause a delay.


Definition at line 512 of file platform/emlib/src/em_pcnt.c

PCNT_Reset#

void PCNT_Reset (PCNT_TypeDef * pcnt)

Reset PCNT to the same state that it was in after a hardware reset.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

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 initialization.

Note

  • The ROUTE register is NOT reset by this function to allow for centralized setup of this feature.


Definition at line 805 of file platform/emlib/src/em_pcnt.c

PCNT_TopBufferSet#

void PCNT_TopBufferSet (PCNT_TypeDef * pcnt, uint32_t val)

Set top buffer value.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

[in]val

A value to set in the top buffer register.

Note

  • This function may stall until synchronization to low-frequency domain is completed. For that reason, it should normally not be used when an external clock is used for the PCNT module since stall time may be undefined.


Definition at line 1001 of file platform/emlib/src/em_pcnt.c

PCNT_TopSet#

void PCNT_TopSet (PCNT_TypeDef * pcnt, uint32_t val)

Set the top value.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

[in]val

A value to set in the top register.

Note

  • This function will stall until synchronization to low-frequency domain is completed. For that reason, it should normally not be used when an external clock is used for the PCNT module since stall time may be undefined.


Definition at line 1026 of file platform/emlib/src/em_pcnt.c

PCNT_CounterGet#

uint32_t PCNT_CounterGet (PCNT_TypeDef * pcnt)

Default configuration for PCNT initialization structure.

Parameters
[in]pcnt

Pointer to the PCNT peripheral register block.

Get the pulse counter value.

Returns

  • Current pulse counter value.


Definition at line 496 of file platform/emlib/inc/em_pcnt.h

PCNT_CounterSet#

void PCNT_CounterSet (PCNT_TypeDef * pcnt, uint32_t count)

Set a counter value.

Parameters
[in]pcnt

Pointer to the PCNT peripheral register block.

[in]count

Value to set in counter register.

Pulse counter is disabled while changing counter value and re-enabled (if originally enabled) when counter value has been set.

Note

  • This function will stall until synchronization to low-frequency domain is completed. For that reason, it should normally not be used when using an external clock to clock the PCNT module since stall time may be undefined in that case. The counter should normally only be set when operating in (or about to enable) pcntModeOvsSingle mode.


Definition at line 542 of file platform/emlib/inc/em_pcnt.h

PCNT_IntClear#

void PCNT_IntClear (PCNT_TypeDef * pcnt, uint32_t flags)

Clear one or more pending PCNT interrupts.

Parameters
[in]pcnt

Pointer to the 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 579 of file platform/emlib/inc/em_pcnt.h

PCNT_IntDisable#

void PCNT_IntDisable (PCNT_TypeDef * pcnt, uint32_t flags)

Disable one or more PCNT interrupts.

Parameters
[in]pcnt

Pointer to the PCNT peripheral register block.

[in]flags

PCNT interrupt sources to disable. Use a bitwise logic OR combination of valid interrupt flags for PCNT module (PCNT_IF_nnn).


Definition at line 599 of file platform/emlib/inc/em_pcnt.h

PCNT_IntEnable#

void PCNT_IntEnable (PCNT_TypeDef * pcnt, uint32_t flags)

Enable one or more PCNT interrupts.

Parameters
[in]pcnt

Pointer to the PCNT peripheral register block.

[in]flags

PCNT interrupt sources to enable. Use a bitwise logic OR combination of valid interrupt flags for PCNT module (PCNT_IF_nnn).

Note

  • Depending on the use, a pending interrupt may already be set prior to enabling the interrupt. To ignore a pending interrupt, consider using PCNT_IntClear() prior to enabling the interrupt.


Definition at line 624 of file platform/emlib/inc/em_pcnt.h

PCNT_IntGet#

uint32_t PCNT_IntGet (PCNT_TypeDef * pcnt)

Get pending PCNT interrupt flags.

Parameters
[in]pcnt

Pointer to the PCNT peripheral register block.

Note

  • The event bits are not cleared by the use of this function.

Returns

  • PCNT interrupt sources pending. A bitwise logic OR combination of valid interrupt flags for PCNT module (PCNT_IF_nnn).


Definition at line 647 of file platform/emlib/inc/em_pcnt.h

PCNT_IntGetEnabled#

uint32_t PCNT_IntGetEnabled (PCNT_TypeDef * pcnt)

Get enabled and pending PCNT interrupt flags.

Parameters
[in]pcnt

Pointer to thePCNT peripheral register block.

Useful for handling more interrupt sources in the same interrupt handler.

Note

  • The event bits are not cleared by the use of this function.

Returns

  • Pending and enabled PCNT interrupt sources. The return value is the bitwise AND combination of

    • the OR combination of enabled interrupt sources in PCNT_IEN_nnn register (PCNT_IEN_nnn) and

    • the OR combination of valid interrupt flags of the PCNT module (PCNT_IF_nnn).


Definition at line 673 of file platform/emlib/inc/em_pcnt.h

PCNT_IntSet#

void PCNT_IntSet (PCNT_TypeDef * pcnt, uint32_t flags)

Set one or more pending PCNT interrupts from SW.

Parameters
[in]pcnt

Pointer to the PCNT peripheral register block.

[in]flags

PCNT interrupt sources to set to pending. Use a bitwise logic OR combination of valid interrupt flags for PCNT module (PCNT_IF_nnn).


Definition at line 696 of file platform/emlib/inc/em_pcnt.h

PCNT_TopBufferGet#

uint32_t PCNT_TopBufferGet (PCNT_TypeDef * pcnt)

Get the pulse counter top buffer value.

Parameters
[in]pcnt

Pointer to the PCNT peripheral register block.

Returns

  • Current pulse counter top buffer value.


Definition at line 749 of file platform/emlib/inc/em_pcnt.h

PCNT_TopGet#

uint32_t PCNT_TopGet (PCNT_TypeDef * pcnt)

Get the pulse counter top value.

Parameters
[in]pcnt

Pointer to the PCNT peripheral register block.

Returns

  • Current pulse counter top value.


Definition at line 770 of file platform/emlib/inc/em_pcnt.h

PCNT_Sync#

void PCNT_Sync (PCNT_TypeDef * pcnt, uint32_t mask)

Wait for an ongoing sync of register(s) to low-frequency domain to complete.

Parameters
[in]pcnt

A pointer to the PCNT peripheral register block.

[in]mask

A bitmask corresponding to SYNCBUSY register defined bits indicating registers that must complete any ongoing synchronization.


Definition at line 792 of file platform/emlib/inc/em_pcnt.h

Macro Definition Documentation#

PCNT0_CNT_SIZE#

#define PCNT0_CNT_SIZE
Value:
(8)

PCNT0 Counter register size.

PCNT0 counter is 8 bits.


Definition at line 53 of file platform/emlib/inc/em_pcnt.h

PCNT1_CNT_SIZE#

#define PCNT1_CNT_SIZE
Value:
(8)

PCNT1 Counter register size.

PCNT1 counter is 8 bits.


Definition at line 61 of file platform/emlib/inc/em_pcnt.h

PCNT2_CNT_SIZE#

#define PCNT2_CNT_SIZE
Value:
(8)

PCNT2 Counter register size.

PCNT2 counter is 8 bits.


Definition at line 70 of file platform/emlib/inc/em_pcnt.h

PCNT_MODE_DISABLE#

#define PCNT_MODE_DISABLE
Value:
0xFF

PCNT mode disable.


Definition at line 78 of file platform/emlib/inc/em_pcnt.h

PCNT_CNT_EVENT_NONE#

#define PCNT_CNT_EVENT_NONE
Value:
0xFF

PCNT count event is none.


Definition at line 80 of file platform/emlib/inc/em_pcnt.h

DEFAULT_DEBUG_HALT#

#define DEFAULT_DEBUG_HALT

Default Debug.


Definition at line 319 of file platform/emlib/inc/em_pcnt.h

DEFAULT_MODE#

#define DEFAULT_MODE
Value:
pcntModeDisable,

Default Mode.

Disabled by default.


Definition at line 323 of file platform/emlib/inc/em_pcnt.h

DEFAULT_HYST#

#define DEFAULT_HYST

Default Hysteresis.


Definition at line 329 of file platform/emlib/inc/em_pcnt.h

DEFAULT_CDIR#

#define DEFAULT_CDIR

Default counter direction.


Definition at line 336 of file platform/emlib/inc/em_pcnt.h

DEFAULT_CNTEV#

#define DEFAULT_CNTEV

Default count event.


Definition at line 343 of file platform/emlib/inc/em_pcnt.h

DEFAULT_AUXCNTEV#

#define DEFAULT_AUXCNTEV

Default auxiliary count event.


Definition at line 350 of file platform/emlib/inc/em_pcnt.h

DEFAULT_PRS_CH#

#define DEFAULT_PRS_CH

Default selected PRS channel as S0IN and S1IN.


Definition at line 359 of file platform/emlib/inc/em_pcnt.h

PCNT_INIT_DEFAULT#

#define PCNT_INIT_DEFAULT
Value:
{ \
DEFAULT_MODE /* Default mode. */ \
_PCNT_CNT_RESETVALUE, /* Default counter HW reset value. */ \
_PCNT_TOP_RESETVALUE, /* Default counter HW reset value. */ \
false, /* Use positive edge. */ \
false, /* Up-counting. */ \
false, /* Filter disabled. */ \
DEFAULT_DEBUG_HALT /* Debug Halt enabled. */ \
DEFAULT_HYST /* Default Hysteresis. */ \
DEFAULT_CDIR /* Default CNTDIR. */ \
DEFAULT_CNTEV /* Faults CNTEV. */ \
DEFAULT_AUXCNTEV /* Default AUXCNTEV. */ \
DEFAULT_PRS_CH /* PRS channel 0 selected as S0IN. */ \
DEFAULT_PRS_CH /* PRS channel 0 selected as S1IN. */ \
}

Default configuration for PCNT initialization structure.


Definition at line 363 of file platform/emlib/inc/em_pcnt.h