Enumerated Types

General Description

Enumerations
enum	cy_en_syspm_status_t {   CY_SYSPM_SUCCESS = 0x0U,   CY_SYSPM_BAD_PARAM = CY_SYSPM_ID | CY_PDL_STATUS_ERROR | 0x01U,   CY_SYSPM_TIMEOUT = CY_SYSPM_ID | CY_PDL_STATUS_ERROR | 0x02U,   CY_SYSPM_INVALID_STATE = CY_SYSPM_ID | CY_PDL_STATUS_ERROR | 0x03U,   CY_SYSPM_CANCELED = CY_SYSPM_ID | CY_PDL_STATUS_ERROR | 0x04U,   CY_SYSPM_SYSCALL_PENDING = CY_SYSPM_ID | CY_PDL_STATUS_ERROR | 0x05U,   CY_SYSPM_FAIL = CY_SYSPM_ID | CY_PDL_STATUS_ERROR | 0xFFU }
	The SysPm function return value status definitions. More...
enum	cy_en_syspm_waitfor_t {   CY_SYSPM_WAIT_FOR_INTERRUPT,   CY_SYSPM_WAIT_FOR_EVENT }
	This enumeration is used to initialize the functions wait action. More...
enum	cy_en_syspm_callback_type_t {   CY_SYSPM_SLEEP = 0U,   CY_SYSPM_DEEPSLEEP = 1U,   CY_SYSPM_HIBERNATE = 2U,   CY_SYSPM_STOP = 3U }
	This enumeration is used to select the low power mode for which the appropriate registered callback handler will be executed. More...
enum	cy_en_syspm_callback_mode_t {   CY_SYSPM_CHECK_READY = 0x01U,   CY_SYSPM_CHECK_FAIL = 0x02U,   CY_SYSPM_BEFORE_TRANSITION = 0x04U,   CY_SYSPM_AFTER_TRANSITION = 0x08U }
	This enumeration specifies the associated callback mode. More...

Enumeration Type Documentation

cy_en_syspm_status_t

enum cy_en_syspm_status_t

The SysPm function return value status definitions.

Enumerator
CY_SYSPM_SUCCESS	Successful.
CY_SYSPM_BAD_PARAM	One or more invalid parameters.
CY_SYSPM_TIMEOUT	A time-out occurred.
CY_SYSPM_INVALID_STATE	The operation is not setup or is in an improper state.
CY_SYSPM_CANCELED	Operation canceled.
CY_SYSPM_SYSCALL_PENDING	Canceled due syscall operation pending.
CY_SYSPM_FAIL	Unknown failure.

cy_en_syspm_waitfor_t

enum cy_en_syspm_waitfor_t

This enumeration is used to initialize the functions wait action.

The wait actions can be - an interrupt or an event. Refer to the CMSIS for WFE and WFI instruction explanations.

Enumerator
CY_SYSPM_WAIT_FOR_INTERRUPT	Wait for an interrupt.
CY_SYSPM_WAIT_FOR_EVENT	Wait for an event.

cy_en_syspm_callback_type_t

enum cy_en_syspm_callback_type_t

This enumeration is used to select the low power mode for which the appropriate registered callback handler will be executed.

For example, the registered callback of the type CY_SYSPM_SLEEP will be executed while switching into the Sleep power mode.

Enumerator
CY_SYSPM_SLEEP	The Sleep enum callback type.
CY_SYSPM_DEEPSLEEP	The Deep Sleep enum callback type.
CY_SYSPM_HIBERNATE	The Hibernate enum callback type.
CY_SYSPM_STOP	The Stop enum callback type.

cy_en_syspm_callback_mode_t

enum cy_en_syspm_callback_mode_t

This enumeration specifies the associated callback mode.

This enum defines the callback mode.

Enumerator
CY_SYSPM_CHECK_READY	Callbacks with this mode are executed before entering into the low power mode. The purpose of his callback function is to check if the device is ready to enter the low power mode.
CY_SYSPM_CHECK_FAIL	Callbacks with this mode are executed after the CY_SYSPM_CHECK_READY callbacks execution returns CY_SYSPM_FAIL. The callback with the CY_SYSPM_CHECK_FAIL mode should roll back the actions performed in the previously executed callback with CY_SYSPM_CHECK_READY
CY_SYSPM_BEFORE_TRANSITION	Callbacks with this mode are executed after the CY_SYSPM_CHECK_READY callbacks execution returns CY_SYSPM_SUCCESS. Performs the actions to be done before entering into the low power mode.
CY_SYSPM_AFTER_TRANSITION	Performs the actions to be done after exiting the low power mode if entered.