Data Structures

group group_syspm_data_structures

Typedefs

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

The type for syspm callbacks.

struct cy_stc_syspm_callback_params_t

#include <>

The structure contains syspm callback parameters.

Public Members

void *base

Base address of a HW instance, matches name of the driver in the API for the base address.

Can be undefined if not required. Base address is not required for the SysPm driver as the device has only one set of power modes

void *context

Context for the handler function.

This item can be skipped if not required. Can be undefined if not required.

struct cy_stc_syspm_callback_t

#include <>

Structure with syspm callback configuration elements.

Public Members

Cy_SysPmCallback callback

The callback handler function.

cy_en_syspm_callback_type_t type

The callback type, see cy_en_syspm_callback_type_t.

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

cy_stc_syspm_callback_params_t *callbackParams

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

struct cy_stc_syspm_callback *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.

struct cy_stc_syspm_callback *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.

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

struct cy_stc_syspm_backup_regs_t

#include <>

This internal structure stores non-retained registers in the system Deep Sleep power mode.

On wakeup from system Deep Sleep, these registers are restored.

Public Members

uint32_t CY_SYSPM_UDB_UDBIF_BANK_CTL_REG

UDB interface control register.

uint32_t CY_SYSPM_UDB_BCTL_MDCLK_EN_REG

UDB bank MDCLK_EN register.

uint32_t CY_SYSPM_UDB_BCTL_MBCLK_EN_REG

UDB bank MBCLK_EN register.

uint32_t CY_SYSPM_UDB_BCTL_BOTSEL_L_REG

UDB bank BOTSEL_L register.

uint32_t CY_SYSPM_UDB_BCTL_BOTSEL_U_REG

UDB bank BOTSEL_U register.

uint32_t CY_SYSPM_UDB_BCTL_QCLK_EN0_REG

UDB bank QCLK_EN0 register.

uint32_t CY_SYSPM_UDB_BCTL_QCLK_EN1_REG

UDB bank QCLK_EN1 register.

uint32_t CY_SYSPM_UDB_BCTL_QCLK_EN2_REG

UDB bank QCLK_EN2 register.

uint32_t CY_SYSPM_CM0_CLOCK_CTL_REG

CPUSS CM0+ clock control register.

note

This parameter is available for CAT1A devices.

uint32_t CY_SYSPM_CM4_CLOCK_CTL_REG

CPUSS CM4 clock control register.

note

This parameter is available for CAT1A devices.