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_hibernate_wakeup_source_t {   CY_SYSPM_HIBERNATE_LPCOMP0_LOW = CY_SYSPM_HIB_WAKEUP_LPCOMP0_MASK,   CY_SYSPM_HIBERNATE_LPCOMP0_HIGH = CY_SYSPM_HIB_WAKEUP_LPCOMP0_MASK | CY_SYSPM_HIB_WAKEUP_LPCOMP0_POLARITY_HIGH_MASK,   CY_SYSPM_HIBERNATE_LPCOMP1_LOW = CY_SYSPM_HIB_WAKEUP_LPCOMP1_MASK,   CY_SYSPM_HIBERNATE_LPCOMP1_HIGH = CY_SYSPM_HIB_WAKEUP_LPCOMP1_MASK | CY_SYSPM_HIB_WAKEUP_LPCOMP1_POLARITY_HIGH_MASK,   CY_SYSPM_HIBERNATE_RTC_ALARM = SRSS_PWR_HIBERNATE_MASK_HIBALARM_Msk,   CY_SYSPM_HIBERNATE_WDT = SRSS_PWR_HIBERNATE_MASK_HIBWDT_Msk,   CY_SYSPM_HIBERNATE_PIN0_LOW = CY_SYSPM_HIB_WAKEUP_PIN0_MASK,   CY_SYSPM_HIBERNATE_PIN0_HIGH = CY_SYSPM_HIB_WAKEUP_PIN0_MASK | CY_SYSPM_HIB_WAKEUP_PIN0_POLARITY_HIGH_MASK,   CY_SYSPM_HIBERNATE_PIN1_LOW = CY_SYSPM_HIB_WAKEUP_PIN1_MASK,   CY_SYSPM_HIBERNATE_PIN1_HIGH = CY_SYSPM_HIB_WAKEUP_PIN1_MASK | CY_SYSPM_HIB_WAKEUP_PIN1_POLARITY_HIGH_MASK }
	This enumeration is used to configure wakeup sources for the System Hibernate power mode. More...
enum	cy_en_syspm_ldo_voltage_t {   CY_SYSPM_LDO_VOLTAGE_ULP = 0U,   CY_SYSPM_LDO_VOLTAGE_LP = 1U,   CY_SYSPM_LDO_VOLTAGE_0_9V = 0U,   CY_SYSPM_LDO_VOLTAGE_1_1V = 1U }
	This enumeration is used to select LDO regulator output voltage. More...
enum	cy_en_syspm_ldo_mode_t {   CY_SYSPM_LDO_MODE_DISABLED = 0U,   CY_SYSPM_LDO_MODE_NORMAL = 1U,   CY_SYSPM_LDO_MODE_MIN = 2U }
	This enumeration is used to select the LDO regulator operating mode. More...
enum	cy_en_syspm_buck_voltage1_t {   CY_SYSPM_BUCK_OUT1_VOLTAGE_ULP = 0x02U,   CY_SYSPM_BUCK_OUT1_VOLTAGE_LP = 0x05U,   CY_SYSPM_BUCK_OUT1_VOLTAGE_0_9V = 0x02U,   CY_SYSPM_BUCK_OUT1_VOLTAGE_1_1V = 0x05U }
	This enumeration is used to select the output voltage for the Buck regulator output 1. More...
enum	cy_en_syspm_buck_out_t {   CY_SYSPM_BUCK_VBUCK_1 = 0x0U,   CY_SYSPM_BUCK_VRF }
	This enumeration is used to select the Buck regulator outputs. More...
enum	cy_en_syspm_buck_voltage2_t {   CY_SYSPM_BUCK_OUT2_VOLTAGE_1_15V = 0U,   CY_SYSPM_BUCK_OUT2_VOLTAGE_1_2V = 1U,   CY_SYSPM_BUCK_OUT2_VOLTAGE_1_25V = 2U,   CY_SYSPM_BUCK_OUT2_VOLTAGE_1_3V = 3U,   CY_SYSPM_BUCK_OUT2_VOLTAGE_1_35V = 4U,   CY_SYSPM_BUCK_OUT2_VOLTAGE_1_4V = 5U,   CY_SYSPM_BUCK_OUT2_VOLTAGE_1_45V = 6U,   CY_SYSPM_BUCK_OUT2_VOLTAGE_1_5V = 7U }
	This enumeration is used to select the output voltage for the Buck regulator output 2, which can source the BLE radio. More...
enum	cy_en_syspm_pmic_wakeup_polarity_t {   CY_SYSPM_PMIC_POLARITY_LOW = 0U,   CY_SYSPM_PMIC_POLARITY_HIGH = 1U }
	This enumeration is used to set the polarity for the PMIC input. More...
enum	cy_en_syspm_vddbackup_control_t {   CY_SYSPM_VDDBACKUP_DEFAULT = 0U,   CY_SYSPM_VDDBACKUP_VBACKUP = 2U }
	This enumeration selects Vbackup or Vddd to supply Vddbackup. More...
enum	cy_en_syspm_sc_charge_key_t {   CY_SYSPM_SC_CHARGE_ENABLE = 0x3CU,   CY_SYSPM_SC_CHARGE_DISABLE = 0x00U }
	This enumeration enables supercapacitor charging. More...
enum	cy_en_syspm_flash_voltage_bit_t {   CY_SYSPM_FLASH_VOLTAGE_BIT_LP = 0U,   CY_SYSPM_FLASH_VOLTAGE_BIT_ULP = 1U }
	This enumeration configures the flash voltage bit for different system power modes. More...
enum	cy_en_syspm_callback_type_t {   CY_SYSPM_SLEEP = 0U,   CY_SYSPM_DEEPSLEEP = 1U,   CY_SYSPM_HIBERNATE = 2U,   CY_SYSPM_LP = 3U,   CY_SYSPM_ULP = 4U }
	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_hibernate_wakeup_source_t

enum cy_en_syspm_hibernate_wakeup_source_t

This enumeration is used to configure wakeup sources for the System Hibernate power mode.

Enumerator
CY_SYSPM_HIBERNATE_LPCOMP0_LOW	Wake on a low logic level for the LPComp0.
CY_SYSPM_HIBERNATE_LPCOMP0_HIGH	Wake on a high logic level for the LPComp0.
CY_SYSPM_HIBERNATE_LPCOMP1_LOW	Wake on a low logic level for the LPComp1.
CY_SYSPM_HIBERNATE_LPCOMP1_HIGH	Wake on a high logic level for the LPComp1.
CY_SYSPM_HIBERNATE_RTC_ALARM	Configure the RTC alarm as wakeup source.
CY_SYSPM_HIBERNATE_WDT	Configure the WDT interrupt as wakeup source.
CY_SYSPM_HIBERNATE_PIN0_LOW	Configure a low logic level for the first wakeup-pin. See device datasheet for specific pin.
CY_SYSPM_HIBERNATE_PIN0_HIGH	Configure a high logic level for the first wakeup-pin. See device datasheet for specific pin.
CY_SYSPM_HIBERNATE_PIN1_LOW	Configure a low logic level for the second wakeup-pin. See device datasheet for specific pin.
CY_SYSPM_HIBERNATE_PIN1_HIGH	Configure a high logic level for the second wakeup-pin. See device datasheet for specific pin.

cy_en_syspm_ldo_voltage_t

enum cy_en_syspm_ldo_voltage_t

This enumeration is used to select LDO regulator output voltage.

Enumerator
CY_SYSPM_LDO_VOLTAGE_ULP	System ULP nominal LDO voltage. See device datasheet for specific voltage.
CY_SYSPM_LDO_VOLTAGE_LP	System LP nominal LDO voltage. See device datasheet for specific voltage.
CY_SYSPM_LDO_VOLTAGE_0_9V	0.9 V nominal LDO voltage
CY_SYSPM_LDO_VOLTAGE_1_1V	1.1 V nominal LDO voltage

cy_en_syspm_ldo_mode_t

enum cy_en_syspm_ldo_mode_t

This enumeration is used to select the LDO regulator operating mode.

Enumerator
CY_SYSPM_LDO_MODE_DISABLED	Disables the LDO.
CY_SYSPM_LDO_MODE_NORMAL	Sets normal current mode. See device datasheet for specific maximum current limit.
CY_SYSPM_LDO_MODE_MIN	Sets minimum current mode. See device datasheet for specific current limit.

cy_en_syspm_buck_voltage1_t

enum cy_en_syspm_buck_voltage1_t

This enumeration is used to select the output voltage for the Buck regulator output 1.

Enumerator
CY_SYSPM_BUCK_OUT1_VOLTAGE_ULP	System ULP nominal Buck voltage. See device datasheet for specific voltage.
CY_SYSPM_BUCK_OUT1_VOLTAGE_LP	LP nominal Buck voltage. See device datasheet for specific voltage.
CY_SYSPM_BUCK_OUT1_VOLTAGE_0_9V	0.9 V nominal Buck voltage
CY_SYSPM_BUCK_OUT1_VOLTAGE_1_1V	1.1 V nominal Buck voltage

cy_en_syspm_buck_out_t

enum cy_en_syspm_buck_out_t

This enumeration is used to select the Buck regulator outputs.

Enumerator
CY_SYSPM_BUCK_VBUCK_1	Buck output 1 Voltage (Vbuck1). Typically used to supply the PSoC digital core logic.
CY_SYSPM_BUCK_VRF	Buck out 2 Voltage (Vbuckrf). Typically used to supply the BLE radio logic.

cy_en_syspm_buck_voltage2_t

enum cy_en_syspm_buck_voltage2_t

This enumeration is used to select the output voltage for the Buck regulator output 2, which can source the BLE radio.

Enumerator
CY_SYSPM_BUCK_OUT2_VOLTAGE_1_15V	1.15 V nominal voltage.
CY_SYSPM_BUCK_OUT2_VOLTAGE_1_2V	1.20 V nominal voltage.
CY_SYSPM_BUCK_OUT2_VOLTAGE_1_25V	1.25 V nominal voltage.
CY_SYSPM_BUCK_OUT2_VOLTAGE_1_3V	1.3 V nominal voltage.
CY_SYSPM_BUCK_OUT2_VOLTAGE_1_35V	1.35 V nominal voltage.
CY_SYSPM_BUCK_OUT2_VOLTAGE_1_4V	1.4 V nominal voltage.
CY_SYSPM_BUCK_OUT2_VOLTAGE_1_45V	1.45 V nominal voltage.
CY_SYSPM_BUCK_OUT2_VOLTAGE_1_5V	1.5 V nominal voltage.

cy_en_syspm_pmic_wakeup_polarity_t

enum cy_en_syspm_pmic_wakeup_polarity_t

This enumeration is used to set the polarity for the PMIC input.

The PMIC output is automatically enabled when the configured polarity of the PMIC input and the logic level driven to the pmic_wakeup_in pin match.

Warning

Do not use CY_SYSPM_PMIC_POLARITY_LOW as it is not supported by hardware.

Enumerator
CY_SYSPM_PMIC_POLARITY_LOW	Set active low logic level for the PMIC input.
CY_SYSPM_PMIC_POLARITY_HIGH	Set active high logic level for the PMIC input.

cy_en_syspm_vddbackup_control_t

enum cy_en_syspm_vddbackup_control_t

This enumeration selects Vbackup or Vddd to supply Vddbackup.

Enumerator
CY_SYSPM_VDDBACKUP_DEFAULT	Logic automatically selects Vddd if present or Vbackup if Vddd is not present to supply Vddbackup.
CY_SYSPM_VDDBACKUP_VBACKUP	Sets only Vbackup to supply Vddbackup.

cy_en_syspm_sc_charge_key_t

enum cy_en_syspm_sc_charge_key_t

This enumeration enables supercapacitor charging.

Enumerator
CY_SYSPM_SC_CHARGE_ENABLE	Enables supercapacitor charging.
CY_SYSPM_SC_CHARGE_DISABLE	Disables supercapacitor charging.

cy_en_syspm_flash_voltage_bit_t

enum cy_en_syspm_flash_voltage_bit_t

This enumeration configures the flash voltage bit for different system power modes.

Enumerator
CY_SYSPM_FLASH_VOLTAGE_BIT_LP	Set the flash voltage bit for system LP mode.
CY_SYSPM_FLASH_VOLTAGE_BIT_ULP	Set the flash voltage bit for system ULP mode.

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_LP	The Low Power enum callback type.
CY_SYSPM_ULP	The Ultra Low Power 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.