General Description

Functions
void	Cy_SysLib_Delay (uint32_t milliseconds)
	The function delays by the specified number of milliseconds. More...

void	Cy_SysLib_DelayUs (uint16_t microseconds)
	The function delays by the specified number of microseconds. More...

void	Cy_SysLib_DelayCycles (uint32_t cycles)
	Delays for the specified number of cycles. More...

void	Cy_SysLib_Halt (uint32_t reason)
	This function halts the CPU but only the CPU which calls the function. More...

void	Cy_SysLib_AssertFailed (const char_t *file, uint32_t line)
	This function stores the ASSERT location of the file name (including path to file) and line number in a non-zero init area for debugging. More...

void	Cy_SysLib_ClearFlashCacheAndBuffer (void)
	This function invalidates the flash cache and buffer. More...

cy_en_syslib_status_t	Cy_SysLib_ResetBackupDomain (void)
	This function resets the backup domain power to avoid the ILO glitch. More...

uint32_t	Cy_SysLib_GetResetReason (void)
	The function returns the cause for the latest reset(s) that occurred in the system. More...

void	Cy_SysLib_ClearResetReason (void)
	This function clears the values of RES_CAUSE and RES_CAUSE2. More...

uint64_t	Cy_SysLib_GetUniqueId (void)
	This function returns the silicon unique ID. More...

void	Cy_SysLib_SoftResetCM4 (void)
	This function performs a CM4 Core software reset using the CM4_PWR_CTL register. More...

void	Cy_SysLib_FaultHandler (uint32_t const *faultStackAddr)
	This function stores the ARM Cortex registers into a non-zero init area for debugging. More...

void	Cy_SysLib_ProcessingFault (void)
	This function determines how to process the current fault state. More...

void	Cy_SysLib_SetWaitStates (bool ulpMode, uint32_t clkHfMHz)
	Sets the number of clock cycles the cache will wait for, before it samples data coming back from ROM, SRAM, and Flash. More...

uint32_t	Cy_SysLib_EnterCriticalSection (void)
	Cy_SysLib_EnterCriticalSection disables interrupts and returns a value indicating whether the interrupts were previously enabled. More...

void	Cy_SysLib_ExitCriticalSection (uint32_t savedIntrStatus)
	Re-enables the interrupts if they were enabled before Cy_SysLib_EnterCriticalSection() was called. More...

Function Documentation

◆ Cy_SysLib_Delay()

void Cy_SysLib_Delay ( uint32_t milliseconds )

The function delays by the specified number of milliseconds.

By default, the number of cycles to delay is calculated based on the SystemCoreClock.

Parameters

milliseconds The number of milliseconds to delay.

Note: The function calls Cy_SysLib_DelayCycles() API to generate a delay. If the function parameter (milliseconds) is bigger than CY_DELAY_MS_OVERFLOW constant, then an additional loop runs to prevent an overflow in parameter passed to Cy_SysLib_DelayCycles() API.

◆ Cy_SysLib_DelayUs()

void Cy_SysLib_DelayUs ( uint16_t microseconds )

The function delays by the specified number of microseconds.

By default, the number of cycles to delay is calculated based on the SystemCoreClock.

Parameters

microseconds The number of microseconds to delay.

Note: If the CPU frequency is a small non-integer number, the actual delay can be up to twice as long as the nominal value. The actual delay cannot be shorter than the nominal one.

◆ Cy_SysLib_DelayCycles()

void Cy_SysLib_DelayCycles ( uint32_t cycles )

Delays for the specified number of cycles.

The function is implemented in the assembler for each supported compiler.

Parameters

cycles The number of cycles to delay.

◆ Cy_SysLib_Halt()

void Cy_SysLib_Halt ( uint32_t reason )

This function halts the CPU but only the CPU which calls the function.

It doesn't affect other CPUs.

Parameters

reason The value to be used during debugging.

Note: The function executes the BKPT instruction for halting CPU and is intended to be used for the debug purpose. A regular use case requires Debugger attachment before the function call. The BKPT instruction causes the CPU to enter the Debug state. Debug tools can use this to investigate the system state, when the instruction at a particular address is reached.; Execution of a BKPT instruction without a debugger attached produces a fault. The fault results in the HardFault exception being taken or causes a Lockup state if it occurs in the NMI or HardFault handler. The default HardFault handler make a software reset if the build option is the release mode (NDEBUG). If the build option is the debug mode, the system will stay in the infinite loop of the Cy_SysLib_ProcessingFault() function.

◆ Cy_SysLib_AssertFailed()

void Cy_SysLib_AssertFailed	(	const char_t *	file,
		uint32_t	line
	)

This function stores the ASSERT location of the file name (including path to file) and line number in a non-zero init area for debugging.

Also it calls the Cy_SysLib_Halt() function to halt the processor.

Parameters

file	The file name of the ASSERT location.
line	The line number of the ASSERT location.

Note: A stored file name and line number could be accessed by cy_assertFileName and cy_assertLine global variables.; This function has the WEAK option, so the user can redefine the function for a custom processing.

◆ Cy_SysLib_ClearFlashCacheAndBuffer()

void Cy_SysLib_ClearFlashCacheAndBuffer ( void )

This function invalidates the flash cache and buffer.

It ensures the valid data is read from flash instead of using outdated data from the cache. The caches' LRU structure is also reset to their default state.

Note: The operation takes a maximum of three clock cycles on the slowest of the clk_slow and clk_fast clocks.

◆ Cy_SysLib_ResetBackupDomain()

cy_en_syslib_status_t Cy_SysLib_ResetBackupDomain ( void )

This function resets the backup domain power to avoid the ILO glitch.

The glitch can occur when the device is reset due to POR/BOD/XRES while the backup voltage is supplied into the system.

Note: Writing 1 to BACKUP->RESET resets the backup logic. Hardware clears it when the reset is complete. After setting the register, this function reads the register immediately for returning the result of the backup domain reset state. The reading register is important because the Read itself takes multiple AHB clock cycles, and the reset is actually finishing during that time.

Returns: CY_SYSLIB_SUCCESS, if BACKUP->RESET read-back is 0. Otherwise returns CY_SYSLIB_INVALID_STATE.

◆ Cy_SysLib_GetResetReason()

uint32_t Cy_SysLib_GetResetReason ( void )

The function returns the cause for the latest reset(s) that occurred in the system.

The reset causes include an HFCLK error, system faults, and device reset on a wakeup from Hibernate mode. The return results are consolidated reset causes from reading RES_CAUSE, RES_CAUSE2 and PWR_HIBERNATE token registers.

Returns: The cause of a system reset.

Name	Value
CY_SYSLIB_RESET_HWWDT	0x00001 (bit0)
CY_SYSLIB_RESET_ACT_FAULT	0x00002 (bit1)
CY_SYSLIB_RESET_DPSLP_FAULT	0x00004 (bit2)
CY_SYSLIB_RESET_CSV_WCO_LOSS	0x00008 (bit3)
CY_SYSLIB_RESET_SOFT	0x00010 (bit4)
CY_SYSLIB_RESET_SWWDT0	0x00020 (bit5)
CY_SYSLIB_RESET_SWWDT1	0x00040 (bit6)
CY_SYSLIB_RESET_SWWDT2	0x00080 (bit7)
CY_SYSLIB_RESET_SWWDT3	0x00100 (bit8)
CY_SYSLIB_RESET_HFCLK_LOSS	0x10000 (bit16)
CY_SYSLIB_RESET_HFCLK_ERR	0x20000 (bit17)
CY_SYSLIB_RESET_HIB_WAKEUP	0x40000 (bit18)

Note: CY_SYSLIB_RESET_CSV_WCO_LOSS, CY_SYSLIB_RESET_HFCLK_LOSS and CY_SYSLIB_RESET_HFCLK_ERR causes of a system reset available only if WCO CSV present in the device.

◆ Cy_SysLib_ClearResetReason()

void Cy_SysLib_ClearResetReason ( void )

This function clears the values of RES_CAUSE and RES_CAUSE2.

Also it clears PWR_HIBERNATE token, which indicates reset event on waking up from HIBERNATE.

◆ Cy_SysLib_GetUniqueId()

uint64_t Cy_SysLib_GetUniqueId ( void )

This function returns the silicon unique ID.

The ID includes Die lot[3]#, Die Wafer#, Die X, Die Y, Die Sort#, Die Minor and Die Year.

Returns: A combined 64-bit unique ID. [63:57] - DIE_YEAR [56:56] - DIE_MINOR [55:48] - DIE_SORT [47:40] - DIE_Y [39:32] - DIE_X [31:24] - DIE_WAFER [23:16] - DIE_LOT[2] [15: 8] - DIE_LOT[1] [ 7: 0] - DIE_LOT[0]

◆ Cy_SysLib_SoftResetCM4()

void Cy_SysLib_SoftResetCM4 ( void )

This function performs a CM4 Core software reset using the CM4_PWR_CTL register.

The register is accessed by CM0 Core by using a command transferred to SROM API through the IPC channel. When the command is sent, the API waits for the IPC channel release.

Note: This function should be called only when the CM4 core is in Deep Sleep mode.; This function will not reset CM0+ Core.; This function waits for an IPC channel release state.

◆ Cy_SysLib_FaultHandler()

void Cy_SysLib_FaultHandler ( uint32_t const * faultStackAddr )

This function stores the ARM Cortex registers into a non-zero init area for debugging.

This function calls Cy_SysLib_ProcessingFault() after storing all information.

Parameters

faultStackAddr The address of the stack pointer, indicates the lowest address in the fault stack frame to be stored.

Note: This function stores the fault stack frame only for the first occurred fault.; The PDL doesn't provide an API to analyze the stored register values. The user has to add additional functions for the analysis, if necessary.; The CY_ARM_FAULT_DEBUG macro defines if the Fault Handler is enabled. By default it is set to CY_ARM_FAULT_DEBUG_ENABLED and enables the Fault Handler. If there is a necessity to save memory or have some specific custom handler, etc. then CY_ARM_FAULT_DEBUG should be redefined as CY_ARM_FAULT_DEBUG_DISABLED. To do this, the following definition should be added to the compiler Command Line (through the project Build Settings): "-D CY_ARM_FAULT_DEBUG=0".

◆ Cy_SysLib_ProcessingFault()

void Cy_SysLib_ProcessingFault ( void )

This function determines how to process the current fault state.

By default in case of exception the system will stay in the infinite loop of this function.

Note: This function has the WEAK option, so the user can redefine the function behavior for a custom processing. For example, the function redefinition could be constructed from fault stack processing and NVIC_SystemReset() function call.

◆ Cy_SysLib_SetWaitStates()

void Cy_SysLib_SetWaitStates	(	bool	ulpMode,
		uint32_t	clkHfMHz
	)

Sets the number of clock cycles the cache will wait for, before it samples data coming back from ROM, SRAM, and Flash.

Call this function before increasing the HFClk0 High Frequency clock. Call this function optionally after lowering the HFClk0 High Frequency clock in order to improve the CPU performance.

Also, call this function before switching the core supply regulator voltage (LDO or SIMO Buck) from 1.1V to 0.9V. Call this function optionally after switching the core supply regulator voltage from 0.9V to 1.1V in order to improve the CPU performance.

Parameters

ulpMode The device power mode. true if the device should be switched to the ULP mode (nominal voltage of the core supply regulator should be switched to 0.9V); false if the device should be switched to the LP mode (nominal voltage of the core supply regulator should be switched to 1.1V).

Note: Refer to the device TRM for the low power modes description.

Parameters

clkHfMHz The HFClk0 clock frequency in MHz. Specifying a frequency above the supported maximum will set the wait states as for the maximum frequency.

◆ Cy_SysLib_EnterCriticalSection()

uint32_t Cy_SysLib_EnterCriticalSection ( void )

Cy_SysLib_EnterCriticalSection disables interrupts and returns a value indicating whether the interrupts were previously enabled.

Returns: Returns the current interrupt status. Returns 0 if the interrupts were previously enabled or 1 if the interrupts were previously disabled.

Note: Implementation of Cy_SysLib_EnterCriticalSection manipulates the IRQ enable bit with interrupts still enabled.

◆ Cy_SysLib_ExitCriticalSection()

void Cy_SysLib_ExitCriticalSection ( uint32_t savedIntrStatus )

Re-enables the interrupts if they were enabled before Cy_SysLib_EnterCriticalSection() was called.

The argument should be the value returned from Cy_SysLib_EnterCriticalSection().

Parameters

savedIntrStatus Puts the saved interrupts status returned by the Cy_SysLib_EnterCriticalSection().

General Description

Functions

Function Documentation

◆ Cy_SysLib_Delay()

◆ Cy_SysLib_DelayUs()

◆ Cy_SysLib_DelayCycles()

◆ Cy_SysLib_Halt()

◆ Cy_SysLib_AssertFailed()

◆ Cy_SysLib_ClearFlashCacheAndBuffer()

◆ Cy_SysLib_ResetBackupDomain()

◆ Cy_SysLib_GetResetReason()

◆ Cy_SysLib_ClearResetReason()

◆ Cy_SysLib_GetUniqueId()

◆ Cy_SysLib_SoftResetCM4()

◆ Cy_SysLib_FaultHandler()

◆ Cy_SysLib_ProcessingFault()

◆ Cy_SysLib_SetWaitStates()

◆ Cy_SysLib_EnterCriticalSection()

◆ Cy_SysLib_ExitCriticalSection()