General Description

Functions
__STATIC_INLINE void	Cy_SysClk_ClkPumpSetSource (cy_en_clkpump_in_sources_t source)
	Sets the source for the pump clock (clk_pump). More...

__STATIC_INLINE cy_en_clkpump_in_sources_t	Cy_SysClk_ClkPumpGetSource (void)
	Reports the source for the pump clock (clk_pump). More...

__STATIC_INLINE void	Cy_SysClk_ClkPumpSetDivider (cy_en_clkpump_divide_t divider)
	Sets the divider of the pump clock (clk_pump). More...

__STATIC_INLINE cy_en_clkpump_divide_t	Cy_SysClk_ClkPumpGetDivider (void)
	Reports the divider value for the pump clock (clk_pump). More...

__STATIC_INLINE void	Cy_SysClk_ClkPumpEnable (void)
	Enables the pump clock (clk_pump). More...

__STATIC_INLINE bool	Cy_SysClk_ClkPumpIsEnabled (void)
	Reports the Enabled/Disabled status of the ClkPump. More...

__STATIC_INLINE void	Cy_SysClk_ClkPumpDisable (void)
	Disables the pump clock (clk_pump). More...

__STATIC_INLINE uint32_t	Cy_SysClk_ClkPumpGetFrequency (void)
	Reports the frequency of the pump clock (clk_pump). More...

Function Documentation

◆ Cy_SysClk_ClkPumpSetSource()

__STATIC_INLINE void Cy_SysClk_ClkPumpSetSource ( cy_en_clkpump_in_sources_t source )

Sets the source for the pump clock (clk_pump).

The pump clock can be used for the analog pumps in the CTBm block.

Parameters

source cy_en_clkpump_in_sources_t

Note: Do not change the source while the pump clock is enabled.

Function Usage: /* Scenario: The pump clock source needs to be updated to path 0 clock. */
if(CY_SYSCLK_PUMP_IN_CLKPATH0 != Cy_SysClk_ClkPumpGetSource())
{
Cy_SysClk_ClkPumpSetSource(CY_SYSCLK_PUMP_IN_CLKPATH0);
}

◆ Cy_SysClk_ClkPumpGetSource()

__STATIC_INLINE cy_en_clkpump_in_sources_t Cy_SysClk_ClkPumpGetSource ( void )

Reports the source for the pump clock (clk_pump).

Returns: cy_en_clkpump_in_sources_t

Function Usage: /* Scenario: The pump clock source needs to be updated to path 0 clock. */
if(CY_SYSCLK_PUMP_IN_CLKPATH0 != Cy_SysClk_ClkPumpGetSource())
{
Cy_SysClk_ClkPumpSetSource(CY_SYSCLK_PUMP_IN_CLKPATH0);
}

◆ Cy_SysClk_ClkPumpSetDivider()

__STATIC_INLINE void Cy_SysClk_ClkPumpSetDivider ( cy_en_clkpump_divide_t divider )

Sets the divider of the pump clock (clk_pump).

Parameters

divider cy_en_clkpump_divide_t

Note: Do not change the divider value while the pump clock is enabled.

Function Usage: /* Scenario: The pump clock divider needs to be updated to 4. */
if(CY_SYSCLK_PUMP_DIV_4 != Cy_SysClk_ClkPumpGetDivider())
{
Cy_SysClk_ClkPumpSetDivider(CY_SYSCLK_PUMP_DIV_4);
}

◆ Cy_SysClk_ClkPumpGetDivider()

__STATIC_INLINE cy_en_clkpump_divide_t Cy_SysClk_ClkPumpGetDivider ( void )

Reports the divider value for the pump clock (clk_pump).

Returns: cy_en_clkpump_divide_t

Function Usage: /* Scenario: The pump clock divider needs to be updated to 4. */
if(CY_SYSCLK_PUMP_DIV_4 != Cy_SysClk_ClkPumpGetDivider())
{
Cy_SysClk_ClkPumpSetDivider(CY_SYSCLK_PUMP_DIV_4);
}

◆ Cy_SysClk_ClkPumpEnable()

__STATIC_INLINE void Cy_SysClk_ClkPumpEnable ( void )

Enables the pump clock (clk_pump).

The pump clock can be used for the analog pumps in the CTBm block.

Function Usage: /* Scenario: The Pump clock must be sourced from the Path 2 clock. The
frequency of the pump clock must be 1/16 of Path 2 clock. */
Cy_SysClk_ClkPumpSetSource(CY_SYSCLK_PUMP_IN_CLKPATH2);
Cy_SysClk_ClkPumpSetDivider(CY_SYSCLK_PUMP_DIV_16);
Cy_SysClk_ClkPumpEnable();
/* Use the pump clock as the source for CTB(m) blocks. */
/* In case if there is a need to get the pump clock frequency */
uint32_t pumpClkFreq = Cy_SysClk_ClkPumpGetFrequency();

◆ Cy_SysClk_ClkPumpIsEnabled()

__STATIC_INLINE bool Cy_SysClk_ClkPumpIsEnabled ( void )

Reports the Enabled/Disabled status of the ClkPump.

Returns: Boolean status of ClkPump: true - Enabled, false - Disabled.

Function Usage: /* Scenario: Pump clock is no longer required and needs to be disabled.
All peripherals clocked using this source are disabled. */
if (Cy_SysClk_ClkPumpIsEnabled())
{
Cy_SysClk_ClkPumpDisable();
}

◆ Cy_SysClk_ClkPumpDisable()

__STATIC_INLINE void Cy_SysClk_ClkPumpDisable ( void )

Disables the pump clock (clk_pump).

Function Usage: /* Scenario: Pump clock is no longer required and needs to be disabled.
All peripherals clocked using this source are disabled. */
if (Cy_SysClk_ClkPumpIsEnabled())
{
Cy_SysClk_ClkPumpDisable();
}

◆ Cy_SysClk_ClkPumpGetFrequency()

__STATIC_INLINE uint32_t Cy_SysClk_ClkPumpGetFrequency ( void )

Reports the frequency of the pump clock (clk_pump).

Note: If the the pump clock is not enabled - a zero frequency is reported.

Function Usage: /* Scenario: The Pump clock must be sourced from the Path 2 clock. The
frequency of the pump clock must be 1/16 of Path 2 clock. */
Cy_SysClk_ClkPumpSetSource(CY_SYSCLK_PUMP_IN_CLKPATH2);
Cy_SysClk_ClkPumpSetDivider(CY_SYSCLK_PUMP_DIV_16);
Cy_SysClk_ClkPumpEnable();
/* Use the pump clock as the source for CTB(m) blocks. */
/* In case if there is a need to get the pump clock frequency */
uint32_t pumpClkFreq = Cy_SysClk_ClkPumpGetFrequency();