Functions
void	Cy_LTC_Init (void)
	Initializes the lifetime counter to its default state. More...

bool	Cy_LTC_IsEnabled (void)
	Returns the lifetime counter HW actual status. More...

void	Cy_LTC_Enable (void)
	Enables the lifetime counter and the counter of the lifetime counter starts counting up. More...

void	Cy_LTC_Disable (void)
	Disables the lifetime counter and the counter of the lifetime counter stops counting, but is not cleared to 0. More...

void	Cy_LTC_SetDivider (cy_en_ltc_div_t divider)
	Configures the divide ratio for the pre-selector. More...

cy_en_ltc_div_t	Cy_LTC_GetDivider (void)
	Returns the divide ratio for the pre-selector value. More...

void	Cy_LTC_SetCounterValue (uint32_t count)
	Configures lifetime counter current value. More...

uint32_t	Cy_LTC_GetCounterValue (void)
	Returns lifetime counter current value. More...

void	Cy_LTC_SetWakeup (uint32_t wakeupValue)
	Configures the lifetime wakeup value. More...

uint32_t	Cy_LTC_GetWakeup (void)
	Returns the lifetime wakeup value. More...

void	Cy_LTC_SetInterrupt (void)
	Triggers an interrupt with software. More...

bool	Cy_LTC_GetInterruptStatus (void)
	Returns the interrupt status. More...

void	Cy_LTC_ClearInterrupt (void)
	Clears the lifetime counter interrupt factor. More...

void	Cy_LTC_SetInterruptMask (bool enable)
	Enables or disables the lifetime counter interrupt handler triggering. More...

bool	Cy_LTC_GetInterruptStatusMasked (void)
	Gets Bitwise "AND" between the interrupt request and mask configuration. More...

Detailed Description

Function Documentation

◆ Cy_LTC_Init()

void Cy_LTC_Init ( void )

Initializes the lifetime counter to its default state.

The Lifetime counter disable.
The Lifetime counter value is set to 0.
The Lifetime wakeup value is set to default(CY_LTC_DEFAULT_WAKEUP_VALUE) value
Configure default(CY_LTC_PRESEL_DIV_2) divide ratio for preselector.
Clear mask and interrupt
The Lifetime counter enable.

Note: Applicable to PSOC4 HVMS/PA only.

Warning: A Low frequency clock source(Low-Frequency Clock) should be enabled before this driver usage.

Returns: none

Function Usage: /* The Watchdog timer should be unlocked before ILO being enabled. */
Cy_WDT_Unlock();
/* A Low frequency clock source should be enabled before this driver usage. */
Cy_SysClk_IloEnable();
/* Initialize the lifetime counter driver */
Cy_LTC_Init();
/* Disable lifetime counter. */
Cy_LTC_Disable();
/* Configure custom divider ratio for preselector. */
Cy_LTC_SetDivider(CY_LTC_PRESEL_DIV_4);
/* Reset Counter value */
Cy_LTC_SetCounterValue(0);
/* Set 1000 ticks */
Cy_LTC_SetWakeup(1000);
/* Due to internal synchronization, it takes about one LFCLK cycle
to update the counters after divider configuration. */
uint16_t delay = (uint16_t) (1000000UL / Cy_SysClk_ClkLfGetFrequency());
/* Wait for LTC counter value changing. */
Cy_SysLib_DelayUs(delay);

/* Enable lifetime counter. */
Cy_LTC_Enable();
/* User can update the wakeup value without disabling the lifetime counter. */
Cy_LTC_SetWakeup(2000);
/* It is recommended to wait for status enabled before entering deepsleep. */
while(!Cy_LTC_IsEnabled())
{
Cy_SysLib_Delay(1UL);
}
/* Put the device into Deep Sleep mode and wait for an interrupt to wake up. */
Cy_SysPm_CpuEnterDeepSleep();
/* The wakeup value is compared against the hardware COUNT value.
If there is a match will deepsleep interrupt occur. */

◆ Cy_LTC_IsEnabled()

bool Cy_LTC_IsEnabled ( void )

Returns the lifetime counter HW actual status.

Note: May lag by up to one Low-Frequency Clock cycle; Applicable to PSOC4 HVMS/PA only.

Returns: true - Lifetime counter actual status is enabled.
false - Lifetime counter actual status is disabled.

Function Usage: /* Check the lifetime counter current status */
if(Cy_LTC_IsEnabled())
{
/* Disable lifetime counter. */
Cy_LTC_Disable();
}
/* Get current counter value. */
uint32_t curCounterVal = Cy_LTC_GetCounterValue();
/* Increase counter to 100 ticks */
Cy_LTC_SetCounterValue(curCounterVal + 100);
/* Enable lifetime counter. */
Cy_LTC_Enable();

◆ Cy_LTC_Enable()

void Cy_LTC_Enable ( void )

Enables the lifetime counter and the counter of the lifetime counter starts counting up.

The user does not need to wait for enable synchronization before entering Deep Sleep. This will occur within one Low-Frequency Clock cycle. But it is recommended to wait for the enabled status before entering Deep sleep ( Cy_SysPm_CpuEnterDeepSleep ).

Note: Due to internal synchronization, may take up to one Low-Frequency Clock cycle to take effect.; Applicable to PSOC4 HVMS/PA only.

Returns: none

Function Usage: /* Check the lifetime counter current status */
if(Cy_LTC_IsEnabled())
{
/* Disable lifetime counter. */
Cy_LTC_Disable();
}
/* Get current counter value. */
uint32_t curCounterVal = Cy_LTC_GetCounterValue();
/* Increase counter to 100 ticks */
Cy_LTC_SetCounterValue(curCounterVal + 100);
/* Enable lifetime counter. */
Cy_LTC_Enable();

◆ Cy_LTC_Disable()

void Cy_LTC_Disable ( void )

Disables the lifetime counter and the counter of the lifetime counter stops counting, but is not cleared to 0.

Note: Due to internal synchronization, may take up to one Low-Frequency Clock cycle to take effect.; Applicable to PSOC4 HVMS/PA only.

Returns: none

Function Usage: /* Check the lifetime counter current status */
if(Cy_LTC_IsEnabled())
{
/* Disable lifetime counter. */
Cy_LTC_Disable();
}
/* Get current counter value. */
uint32_t curCounterVal = Cy_LTC_GetCounterValue();
/* Increase counter to 100 ticks */
Cy_LTC_SetCounterValue(curCounterVal + 100);
/* Enable lifetime counter. */
Cy_LTC_Enable();

◆ Cy_LTC_SetDivider()

void Cy_LTC_SetDivider ( cy_en_ltc_div_t divider )

Configures the divide ratio for the pre-selector.

Warning: Writes will be ignored when lifetime counter is enabled by Cy_LTC_Enable function.

Note: Due to internal synchronization, it takes about 1 Low-Frequency Clock cycle to update the counters after configuration.; Applicable to PSOC4 HVMS/PA only.

Parameters

divider cy_en_ltc_div_t

Returns: none

Function Usage: /* Disable lifetime counter. */
Cy_LTC_Disable();
/* Configure custom divider ratio for preselector. */
Cy_LTC_SetDivider(CY_LTC_PRESEL_DIV_8);

/* Counter will start from 100 value */
Cy_LTC_SetCounterValue(100);
/* Set wakeup on 1000 ticks */
Cy_LTC_SetWakeup(1000);
/* Due to internal synchronization, it takes about one LFCLK cycle
to update the counters after divider configuration. */
uint16_t delay = (uint16_t) (1000000UL / Cy_SysClk_ClkLfGetFrequency());
/* Wait for LTC counter value changing. */
Cy_SysLib_DelayUs(delay);
/* Enable lifetime counter. */
Cy_LTC_Enable();

◆ Cy_LTC_GetDivider()

cy_en_ltc_div_t Cy_LTC_GetDivider ( void )

Returns the divide ratio for the pre-selector value.

Note: Applicable to PSOC4 HVMS/PA only.

Returns: cy_en_ltc_div_t :
CY_LTC_PRESEL_DIV_2 - Divide Low-Frequency Clock by 2.
CY_LTC_PRESEL_DIV_4 - Divide Low-Frequency Clock by 4.
CY_LTC_PRESEL_DIV_8 - Divide Low-Frequency Clock by 8.
CY_LTC_PRESEL_DIV_16 - Divide Low-Frequency Clock by 16.
CY_LTC_PRESEL_DIV_32 - Divide Low-Frequency Clock by 32.

Function Usage: /* Disable lifetime counter. */
Cy_LTC_Disable();
/* Configure custom divider ratio for preselector. */
Cy_LTC_SetDivider(CY_LTC_PRESEL_DIV_4);
cy_en_ltc_div_t curDiv = Cy_LTC_GetDivider();
switch(curDiv)
{
case CY_LTC_PRESEL_DIV_2:
/* handle current value */
break;
case CY_LTC_PRESEL_DIV_4:
/* handle current value */
break;
case CY_LTC_PRESEL_DIV_8:
/* handle current value */
break;
case CY_LTC_PRESEL_DIV_16:
/* handle current value */
break;
case CY_LTC_PRESEL_DIV_32:
/* handle current value */
break;
default:
/* handle current value */
break;
}

◆ Cy_LTC_SetCounterValue()

void Cy_LTC_SetCounterValue ( uint32_t count )

Configures lifetime counter current value.

Note: This function configuration is ignored when lifetime counter enabled.; The counter doesn't increment unless enabled(Cy_LTC_Enable).; The counter doesn't increment unless enabled(Cy_LTC_Enable).; Due to internal synchronization, it takes about one Low-Frequency Clock cycle to update the counters after divider configuration and counter needs to be disabled one Low-Frequency Clock cycle for the internal synchronization of this counter to take place.

Warning: Do not change this setting when lifetime counter is enabled.

Note: Applicable to PSOC4 HVMS/PA only.

Parameters

count Lifetime counter current value.

Returns: none

Function Usage: /* Check the lifetime counter current status */
if(Cy_LTC_IsEnabled())
{
/* Disable lifetime counter. */
Cy_LTC_Disable();
}
/* Get current counter value. */
uint32_t curCounterVal = Cy_LTC_GetCounterValue();
/* Increase counter to 100 ticks */
Cy_LTC_SetCounterValue(curCounterVal + 100);
/* Enable lifetime counter. */
Cy_LTC_Enable();

◆ Cy_LTC_GetCounterValue()

uint32_t Cy_LTC_GetCounterValue ( void )

Returns lifetime counter current value.

Note: The counter doesn't increment unless enabled(Cy_LTC_Enable).; Applicable to PSOC4 HVMS/PA only.

Returns: The lifetime current counter value.

Function Usage: /* Check the lifetime counter current status */
if(Cy_LTC_IsEnabled())
{
/* Disable lifetime counter. */
Cy_LTC_Disable();
}
/* Get current counter value. */
uint32_t curCounterVal = Cy_LTC_GetCounterValue();
/* Increase counter to 100 ticks */
Cy_LTC_SetCounterValue(curCounterVal + 100);
/* Enable lifetime counter. */
Cy_LTC_Enable();

◆ Cy_LTC_SetWakeup()

void Cy_LTC_SetWakeup ( uint32_t wakeupValue )

Configures the lifetime wakeup value.

The user can change the WAKEUP value without disabling the lifetime counter.

Note: Applicable to PSOC4 HVMS/PA only.

Parameters

wakeupValue Lifetime wakeup value.

Returns: none

Function Usage: /* Get current wakeup value. */
uint32_t curWakeupVal = Cy_LTC_GetWakeup();
/* Increase wakeup to 100 ticks */
Cy_LTC_SetWakeup(curWakeupVal + 100);

◆ Cy_LTC_GetWakeup()

uint32_t Cy_LTC_GetWakeup ( void )

Returns the lifetime wakeup value.

Note: Applicable to PSOC4 HVMS/PA only.

Returns: The lifetime wakeup value.

Function Usage: /* Get current wakeup value. */
uint32_t curWakeupVal = Cy_LTC_GetWakeup();
/* Increase wakeup to 100 ticks */
Cy_LTC_SetWakeup(curWakeupVal + 100);

◆ Cy_LTC_SetInterrupt()

void Cy_LTC_SetInterrupt ( void )

Triggers an interrupt with software.

Can be used to set interrupts for firmware testing.

Note: Applicable to PSOC4 HVMS/PA only.

Returns: none

◆ Cy_LTC_GetInterruptStatus()

bool Cy_LTC_GetInterruptStatus ( void )

Returns the interrupt status.

Note: Applicable to PSOC4 HVMS/PA only.

Returns: True - Interrupt occurred.
False - Interrupt did not occur.

Function Usage: #define SYSCLK_INTR_NUM ((IRQn_Type) srss_interrupt_srss_IRQn)
#define SYSCLK_INTR_PRIORITY (3U)
/* Configuration structure */
static cy_stc_sysint_t sysClkIntrConfig =
{
.intrSrc = SYSCLK_INTR_NUM,
.intrPriority = SYSCLK_INTR_PRIORITY,
};
static bool wakeupTiggered = false;
static void LTC_Isr(void)
{
/* Check interrupt happening. */
if (Cy_LTC_GetInterruptStatus())
{
/* Clear the lifetime counter interrupt. */
Cy_LTC_ClearInterrupt();
wakeupTiggered = true;
}
}
void LTC_Example_Main(void)
{
/* Hook interrupt service routine */
(void) Cy_SysInt_Init(&sysClkIntrConfig, &LTC_Isr);

/* enable interrupt for interrupt controller */
NVIC_EnableIRQ(SYSCLK_INTR_NUM);
/* The Watchdog timer should be unlocked before ILO being enabled. */
Cy_WDT_Unlock();
/* A Low frequency clock source should be enabled before this driver usage. */
Cy_SysClk_IloEnable();
/* Initialize the lifetime counter driver */
Cy_LTC_Init();
/* Set wakeup on 1000 ticks */
Cy_LTC_SetWakeup(1000);
/* It is recommended to wait for status enabled before entering deepsleep. */
while(!Cy_LTC_IsEnabled())
{
Cy_SysLib_Delay(1UL);
}
/* Put the device into Deep Sleep mode and wait for an interrupt to wake up. */
Cy_SysPm_CpuEnterDeepSleep();
/* Check interrupt happening. */
if(wakeupTiggered)
{
/* handle wakeup */
}
}

◆ Cy_LTC_ClearInterrupt()

void Cy_LTC_ClearInterrupt ( void )

Clears the lifetime counter interrupt factor.

Note: Applicable to PSOC4 HVMS/PA only.

Returns: none

Function Usage: #define SYSCLK_INTR_NUM ((IRQn_Type) srss_interrupt_srss_IRQn)
#define SYSCLK_INTR_PRIORITY (3U)
/* Configuration structure */
static cy_stc_sysint_t sysClkIntrConfig =
{
.intrSrc = SYSCLK_INTR_NUM,
.intrPriority = SYSCLK_INTR_PRIORITY,
};
static bool wakeupTiggered = false;
static void LTC_Isr(void)
{
/* Check interrupt happening. */
if (Cy_LTC_GetInterruptStatus())
{
/* Clear the lifetime counter interrupt. */
Cy_LTC_ClearInterrupt();
wakeupTiggered = true;
}
}
void LTC_Example_Main(void)
{
/* Hook interrupt service routine */
(void) Cy_SysInt_Init(&sysClkIntrConfig, &LTC_Isr);

/* enable interrupt for interrupt controller */
NVIC_EnableIRQ(SYSCLK_INTR_NUM);
/* The Watchdog timer should be unlocked before ILO being enabled. */
Cy_WDT_Unlock();
/* A Low frequency clock source should be enabled before this driver usage. */
Cy_SysClk_IloEnable();
/* Initialize the lifetime counter driver */
Cy_LTC_Init();
/* Set wakeup on 1000 ticks */
Cy_LTC_SetWakeup(1000);
/* It is recommended to wait for status enabled before entering deepsleep. */
while(!Cy_LTC_IsEnabled())
{
Cy_SysLib_Delay(1UL);
}
/* Put the device into Deep Sleep mode and wait for an interrupt to wake up. */
Cy_SysPm_CpuEnterDeepSleep();
/* Check interrupt happening. */
if(wakeupTiggered)
{
/* handle wakeup */
}
}

◆ Cy_LTC_SetInterruptMask()

void Cy_LTC_SetInterruptMask ( bool enable )

Enables or disables the lifetime counter interrupt handler triggering.

Note: Applicable to PSOC4 HVMS/PA only.

Parameters

enable true : to masking interrupt. After masking the interrupt, it is not passed to the CPU.
false : to reset masking. After unmasking the interrupt, it is passed to CPU.

Returns: none

Function Usage: /* Unmask interrupts if interrupts were masked */
if(Cy_LTC_GetInterruptStatusMasked())
{
/* Configure interrupt mask */
Cy_LTC_SetInterruptMask(false);
}

/* Clear the lifetime counter interrupt. */
Cy_LTC_ClearInterrupt();

◆ Cy_LTC_GetInterruptStatusMasked()

bool Cy_LTC_GetInterruptStatusMasked ( void )

Gets Bitwise "AND" between the interrupt request and mask configuration.

Note: Applicable to PSOC4 HVMS/PA only.

Returns: true : There is Lifetime Counter interrupt factor and mask bit is set
false : There is no Lifetime Counter interrupt factor or mask bit is cleared

Function Usage: /* Unmask interrupts if interrupts were masked */
if(Cy_LTC_GetInterruptStatusMasked())
{
/* Configure interrupt mask */
Cy_LTC_SetInterruptMask(false);
}

/* Clear the lifetime counter interrupt. */
Cy_LTC_ClearInterrupt();

Functions

Detailed Description

Function Documentation

◆ Cy_LTC_Init()

◆ Cy_LTC_IsEnabled()

◆ Cy_LTC_Enable()

◆ Cy_LTC_Disable()

◆ Cy_LTC_SetDivider()

◆ Cy_LTC_GetDivider()

◆ Cy_LTC_SetCounterValue()

◆ Cy_LTC_GetCounterValue()

◆ Cy_LTC_SetWakeup()

◆ Cy_LTC_GetWakeup()

◆ Cy_LTC_SetInterrupt()

◆ Cy_LTC_GetInterruptStatus()

◆ Cy_LTC_ClearInterrupt()

◆ Cy_LTC_SetInterruptMask()

◆ Cy_LTC_GetInterruptStatusMasked()