PCNT - Pulse Counter#

PCNT_Mode_TypeDef#

PCNT_Mode_TypeDef

Mode selection.

PCNT_CntEvent_TypeDef#

PCNT_CntEvent_TypeDef

Counter event selection.

Note: unshifted values are being used for enumeration because multiple configuration structure members use this type definition.

PCNT_PRSSel_TypeDef#

PCNT_PRSSel_TypeDef

PRS sources for s0PRS and s1PRS.

PCNT_PRSInput_TypeDef#

PCNT_PRSInput_TypeDef

PRS inputs of PCNT.

PCNT_CounterGet#

uint32_t PCNT_CounterGet (PCNT_TypeDef * pcnt)

Default configuration for PCNT initialization structure.

Get the pulse counter value.

Returns

• Current pulse counter value.

PCNT_AuxCounterGet#

uint32_t PCNT_AuxCounterGet (PCNT_TypeDef * pcnt)

Get the auxiliary counter value.

Returns

• Current auxiliary counter value.

PCNT_CounterReset#

void PCNT_CounterReset (PCNT_TypeDef * pcnt)

Reset PCNT counters and TOP register.

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.

PCNT_CounterTopSet#

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

Set the counter and top values.

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.

PCNT_CounterSet#

void PCNT_CounterSet (PCNT_TypeDef * pcnt, uint32_t count)

Set a counter value.

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.

PCNT_Enable#

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.

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.

PCNT_IsEnabled#

bool PCNT_IsEnabled (PCNT_TypeDef * pcnt)

Returns if the PCNT module is enabled or not.

Notice that this function does not do any configuration.

Returns

• Returns TRUE if the module is enabled.

PCNT_FreezeEnable#

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

PCNT_Init#

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

Initialize the pulse counter.

This function will configure the pulse counter. The clock selection is configured as follows, depending on operational mode:

• pcntModeOvsSingle - Use LFACLK.

• pcntModeExtSingle - Use external PCNTn_S0 pin.

• pcntModeExtQuad - Use external PCNTn_S0 pin.

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.

PCNT_PRSInputEnable#

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.

PCNT_IntClear#

void PCNT_IntClear (PCNT_TypeDef * pcnt, uint32_t flags)

Clear one or more pending PCNT interrupts.

PCNT_IntDisable#

void PCNT_IntDisable (PCNT_TypeDef * pcnt, uint32_t flags)

Disable one or more PCNT interrupts.

PCNT_IntEnable#

void PCNT_IntEnable (PCNT_TypeDef * pcnt, uint32_t flags)

Enable one or more PCNT interrupts.

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.

PCNT_IntGet#

uint32_t PCNT_IntGet (PCNT_TypeDef * pcnt)

Get pending PCNT interrupt flags.

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

PCNT_IntGetEnabled#

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.

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

PCNT_IntSet#

void PCNT_IntSet (PCNT_TypeDef * pcnt, uint32_t flags)

Set one or more pending PCNT interrupts from SW.

PCNT_Reset#

void PCNT_Reset (PCNT_TypeDef * pcnt)

Reset PCNT to the same state that it was in after a hardware 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 initialization.

Note

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

PCNT_TopBufferGet#

uint32_t PCNT_TopBufferGet (PCNT_TypeDef * pcnt)

Get the pulse counter top buffer value.

Returns

• Current pulse counter top buffer value.

PCNT_TopBufferSet#

void PCNT_TopBufferSet (PCNT_TypeDef * pcnt, uint32_t val)

Set top buffer value.

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.

PCNT_TopGet#

uint32_t PCNT_TopGet (PCNT_TypeDef * pcnt)

Get the pulse counter top value.

Returns

• Current pulse counter top value.

PCNT_TopSet#

void PCNT_TopSet (PCNT_TypeDef * pcnt, uint32_t val)

Set the top value.

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.

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.