Functions

Functions
cy_en_sysclk_status_t	Cy_SysClk_ClkPumpSetSource (cy_en_sysclk_clkpump_src_t source)
	Sets the source for the pump clock (clk_pump). More...
__STATIC_INLINE cy_en_sysclk_clkpump_src_t	Cy_SysClk_ClkPumpGetSource (void)
	Reports the source for the pump clock (clk_pump). More...
__STATIC_INLINE uint32_t	Cy_SysClk_ClkPumpGetFrequency (void)
	Reports the frequency of the pump clock (clk_pump). More...

Detailed Description

Function Documentation

Cy_SysClk_ClkPumpSetSource()

cy_en_sysclk_status_t Cy_SysClk_ClkPumpSetSource

(

cy_en_sysclk_clkpump_src_t

source

)

Sets the source for the pump clock (clk_pump).

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

Parameters

source

cy_en_sysclk_clkpump_src_t

Returns

Error / status code cy_en_sysclk_status_t :
CY_SYSCLK_SUCCESS - the source is successfully set
CY_SYSCLK_INVALID_STATE - the selected clock source is not enabled
CY_SYSCLK_BAD_PARAM - the source parameter is invalid.

Function Usage

    /* Scenario: The Pump should be clocked by the HFCLK. */

    if(CY_SYSCLK_PUMP_IN_HFCLK != Cy_SysClk_ClkPumpGetSource())
    {
        Cy_SysClk_ClkPumpSetSource(CY_SYSCLK_PUMP_IN_HFCLK);
    }

    /* In case if there is a need to get the Pump clock frequency */
    uint32_t pumpClkFreq = Cy_SysClk_ClkPumpGetFrequency();

Cy_SysClk_ClkPumpGetSource()

__STATIC_INLINE cy_en_sysclk_clkpump_src_t Cy_SysClk_ClkPumpGetSource

(

void

)

Reports the source for the pump clock (clk_pump).

Returns

cy_en_sysclk_clkpump_src_t :
CY_SYSCLK_PUMP_IN_GND - No clock, connect to gnd.
CY_SYSCLK_PUMP_IN_IMO - Use main IMO output.
CY_SYSCLK_PUMP_IN_HFCLK - Use clk_hf (using selected source after predivider but before prescaler).

Function Usage

    /* Scenario: The Pump should be clocked by the HFCLK. */

    if(CY_SYSCLK_PUMP_IN_HFCLK != Cy_SysClk_ClkPumpGetSource())
    {
        Cy_SysClk_ClkPumpSetSource(CY_SYSCLK_PUMP_IN_HFCLK);
    }

    /* In case if there is a need to get the Pump clock frequency */
    uint32_t pumpClkFreq = Cy_SysClk_ClkPumpGetFrequency();

Cy_SysClk_ClkPumpGetFrequency()

__STATIC_INLINE uint32_t Cy_SysClk_ClkPumpGetFrequency

(

void

)

Reports the frequency of the pump clock (clk_pump).

Returns

The frequency of the pump clock in Hz.

Function Usage

    /* Scenario: The Pump should be clocked by the HFCLK. */

    if(CY_SYSCLK_PUMP_IN_HFCLK != Cy_SysClk_ClkPumpGetSource())
    {
        Cy_SysClk_ClkPumpSetSource(CY_SYSCLK_PUMP_IN_HFCLK);
    }

    /* In case if there is a need to get the Pump clock frequency */
    uint32_t pumpClkFreq = Cy_SysClk_ClkPumpGetFrequency();