PSoC 4 Peripheral Driver Library - Alpha

General Description

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

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

Parameters
sourcecy_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 ClkHf. */
{
}
/* 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
Function Usage
/* Scenario: The Pump should be clocked by the ClkHf. */
{
}
/* 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 ClkHf. */
{
}
/* In case if there is a need to get the Pump clock frequency */
uint32_t pumpClkFreq = Cy_SysClk_ClkPumpGetFrequency();