PSoC 6 Peripheral Driver Library
Low Power Callbacks

General Description

Functions

cy_en_syspm_status_t Cy_RTC_DeepSleepCallback (const cy_stc_syspm_callback_params_t *callbackParams, cy_en_syspm_callback_mode_t mode)
 This function checks the RTC_BUSY bit to avoid data corruption before enters the Deep Sleep mode. More...
 
cy_en_syspm_status_t Cy_RTC_HibernateCallback (const cy_stc_syspm_callback_params_t *callbackParams, cy_en_syspm_callback_mode_t mode)
 This function checks the RTC_BUSY bit to avoid data corruption before enters the Hibernate mode. More...
 

Function Documentation

◆ Cy_RTC_DeepSleepCallback()

cy_en_syspm_status_t Cy_RTC_DeepSleepCallback ( const cy_stc_syspm_callback_params_t callbackParams,
cy_en_syspm_callback_mode_t  mode 
)

This function checks the RTC_BUSY bit to avoid data corruption before enters the Deep Sleep mode.

Parameters
callbackParamsThe structure with the SysPm callback parameters, see cy_stc_syspm_callback_params_t
modeCallback mode, see cy_en_syspm_callback_mode_t.
Returns
The SysPm return status, see cy_en_syspm_status_t.
Note
The *base and *context elements are required to be present in the parameter structure because this function uses the SysPm driver callback type. The SysPm driver callback function type requires implementing the function with next parameters and return value:

cy_en_syspm_status_t (*Cy_SysPmCallback) (cy_stc_syspm_callback_params_t *callbackParams, cy_en_syspm_callback_mode_t mode);

◆ Cy_RTC_HibernateCallback()

cy_en_syspm_status_t Cy_RTC_HibernateCallback ( const cy_stc_syspm_callback_params_t callbackParams,
cy_en_syspm_callback_mode_t  mode 
)

This function checks the RTC_BUSY bit to avoid data corruption before enters the Hibernate mode.

Parameters
callbackParamsstructure with the syspm callback parameters, see cy_stc_syspm_callback_params_t.
modeCallback mode, see cy_en_syspm_callback_mode_t
Returns
The syspm return status, see cy_en_syspm_status_t
Note
The *base and *context elements are required to be present in the parameter structure because this function uses the SysPm driver callback type. The SysPm driver callback function type requires implementing the function with next parameters and return value:

cy_en_syspm_status_t (*Cy_SysPmCallback) (cy_stc_syspm_callback_params_t *callbackParams, cy_en_syspm_callback_mode_t mode);