CAT2 Peripheral Driver Library
cy_stc_syspm_callback_t Struct Reference

Description

Structure with syspm callback configuration elements.

Data Fields

Cy_SysPmCallback callback
 The callback handler function. More...
 
cy_en_syspm_callback_type_t type
 The callback type, see cy_en_syspm_callback_type_t. More...
 
uint32_t skipMode
 The mask of modes to be skipped during callback execution, see Defines to skip the callbacks modes. More...
 
cy_stc_syspm_callback_params_tcallbackParams
 The address of a cy_stc_syspm_callback_params_t, the callback is executed with these parameters. More...
 
struct cy_stc_syspm_callback * prevItm
 The previous list item. More...
 
struct cy_stc_syspm_callback * nextItm
 The next list item. More...
 
uint8_t order
 Holds the callback execution order value. More...
 

Field Documentation

◆ callback

Cy_SysPmCallback cy_stc_syspm_callback_t::callback

The callback handler function.

◆ type

cy_en_syspm_callback_type_t cy_stc_syspm_callback_t::type

The callback type, see cy_en_syspm_callback_type_t.

◆ skipMode

uint32_t cy_stc_syspm_callback_t::skipMode

The mask of modes to be skipped during callback execution, see Defines to skip the callbacks modes.

The corresponding callback mode won't execute if the appropriate define is set. These values can be ORed. If all modes are required to be executed this element should be equal to zero. Skipping unneeded callback modes speeds up power mode transitions by skipping unneeded operations.

◆ callbackParams

cy_stc_syspm_callback_params_t* cy_stc_syspm_callback_t::callbackParams

The address of a cy_stc_syspm_callback_params_t, the callback is executed with these parameters.

◆ prevItm

struct cy_stc_syspm_callback* cy_stc_syspm_callback_t::prevItm

The previous list item.

This element should not be defined, or defined as NULL. It is for internal usage to link this structure to the next registered structure. It will be updated during callback registration. Do not modify this element at run-time.

◆ nextItm

struct cy_stc_syspm_callback* cy_stc_syspm_callback_t::nextItm

The next list item.

This element should not be defined, or defined as NULL. It is for internal usage to link this structure to the previous registered structure. It will be updated during callback registration. Do not modify this element at run-time.

◆ order

uint8_t cy_stc_syspm_callback_t::order

Holds the callback execution order value.

Range: 0-255. While entering low power mode, callbacks with lower order values are executed first. While exiting low power mode, the callbacks are executed in the opposite order. Callbacks with the same order value are executed in the order they are registered in the application.