Enumerated Types

group group_syspm_data_enumerates

Enums

enum cy_en_syspm_status_t

cy_en_syspm_status_t: The SysPm function return value status definitions.

Values:

enumerator CY_SYSPM_SUCCESS

Successful.

enumerator CY_SYSPM_BAD_PARAM

One or more invalid parameters.

enumerator CY_SYSPM_TIMEOUT

A time-out occurred.

enumerator CY_SYSPM_INVALID_STATE

The operation is not setup or is in an improper state.

enumerator CY_SYSPM_CANCELED

Operation canceled.

enumerator CY_SYSPM_SYSCALL_PENDING

Canceled due syscall operation pending.

enumerator CY_SYSPM_FAIL

Unknown failure.

enum cy_en_syspm_waitfor_t

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.

Values:

enumerator CY_SYSPM_WAIT_FOR_INTERRUPT

Wait for an interrupt.

enumerator CY_SYSPM_WAIT_FOR_EVENT

Wait for an event.

enum cy_en_syspm_hibernate_wakeup_source_t

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

Values:

enumerator CY_SYSPM_HIBERNATE_LPCOMP0_LOW

Wake on a low logic level for the LPComp0.

enumerator CY_SYSPM_HIBERNATE_LPCOMP0_HIGH

Wake on a high logic level for the LPComp0.

enumerator CY_SYSPM_HIBERNATE_LPCOMP1_LOW

Wake on a low logic level for the LPComp1.

enumerator CY_SYSPM_HIBERNATE_LPCOMP1_HIGH

Wake on a high logic level for the LPComp1.

enumerator CY_SYSPM_HIBERNATE_RTC_ALARM

Configure the RTC alarm as wakeup source.

enumerator CY_SYSPM_HIBERNATE_WDT

Configure the WDT interrupt as wakeup source.

enumerator CY_SYSPM_HIBERNATE_PIN0_LOW

Configure a low logic level for the first wakeup-pin.

See device datasheet for specific pin.

enumerator CY_SYSPM_HIBERNATE_PIN0_HIGH

Configure a high logic level for the first wakeup-pin.

See device datasheet for specific pin.

enumerator CY_SYSPM_HIBERNATE_PIN1_LOW

Configure a low logic level for the second wakeup-pin.

See device datasheet for specific pin.

enumerator CY_SYSPM_HIBERNATE_PIN1_HIGH

Configure a high logic level for the second wakeup-pin.

See device datasheet for specific pin.

enum cy_en_syspm_ldo_voltage_t

cy_en_syspm_ldo_voltage_t: This enumeration is used to select LDO regulator output voltage.

Values:

enumerator CY_SYSPM_LDO_VOLTAGE_ULP

System ULP nominal LDO voltage.

See device datasheet for specific voltage.

enumerator CY_SYSPM_LDO_VOLTAGE_LP

System LP nominal LDO voltage.

See device datasheet for specific voltage.

enumerator CY_SYSPM_LDO_VOLTAGE_0_9V

0.9 V nominal LDO voltage

enumerator CY_SYSPM_LDO_VOLTAGE_1_1V

1.1 V nominal LDO voltage

enum cy_en_syspm_ldo_mode_t

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

Values:

enumerator CY_SYSPM_LDO_MODE_DISABLED

Disables the LDO.

enumerator CY_SYSPM_LDO_MODE_NORMAL

Sets normal current mode.

See device datasheet for specific maximum current limit.

enumerator CY_SYSPM_LDO_MODE_MIN

Sets minimum current mode.

See device datasheet for specific current limit.

enum cy_en_syspm_buck_voltage1_t

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

Values:

enumerator CY_SYSPM_BUCK_OUT1_VOLTAGE_ULP

System ULP nominal Buck voltage.

See device datasheet for specific voltage.

enumerator CY_SYSPM_BUCK_OUT1_VOLTAGE_LP

LP nominal Buck voltage.

See device datasheet for specific voltage.

enumerator CY_SYSPM_BUCK_OUT1_VOLTAGE_0_9V

0.9 V nominal Buck voltage

enumerator CY_SYSPM_BUCK_OUT1_VOLTAGE_1_1V

1.1 V nominal Buck voltage

enum cy_en_syspm_buck_out_t

cy_en_syspm_buck_out_t: This enumeration is used to select the Buck regulator outputs.

Values:

enumerator CY_SYSPM_BUCK_VBUCK_1

Buck output 1 Voltage (Vbuck1).

Typically used to supply the PSoC digital core logic.

enumerator CY_SYSPM_BUCK_VRF

Buck out 2 Voltage (Vbuckrf).

Typically used to supply the BLE radio logic.

enum cy_en_syspm_buck_voltage2_t

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.

Values:

enumerator CY_SYSPM_BUCK_OUT2_VOLTAGE_1_15V

1.15 V nominal voltage.

enumerator CY_SYSPM_BUCK_OUT2_VOLTAGE_1_2V

1.20 V nominal voltage.

enumerator CY_SYSPM_BUCK_OUT2_VOLTAGE_1_25V

1.25 V nominal voltage.

enumerator CY_SYSPM_BUCK_OUT2_VOLTAGE_1_3V

1.3 V nominal voltage.

enumerator CY_SYSPM_BUCK_OUT2_VOLTAGE_1_35V

1.35 V nominal voltage.

enumerator CY_SYSPM_BUCK_OUT2_VOLTAGE_1_4V

1.4 V nominal voltage.

enumerator CY_SYSPM_BUCK_OUT2_VOLTAGE_1_45V

1.45 V nominal voltage.

enumerator CY_SYSPM_BUCK_OUT2_VOLTAGE_1_5V

1.5 V nominal voltage.

enum cy_en_syspm_pmic_wakeup_polarity_t

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.

Values:

enumerator CY_SYSPM_PMIC_POLARITY_LOW

Set active low logic level for the PMIC input.

enumerator CY_SYSPM_PMIC_POLARITY_HIGH

Set active high logic level for the PMIC input.

enum cy_en_syspm_vddbackup_control_t

cy_en_syspm_vddbackup_control_t: This enumeration selects Vbackup or Vddd to supply Vddbackup.

Values:

enumerator CY_SYSPM_VDDBACKUP_DEFAULT

Logic automatically selects Vddd if present or Vbackup if Vddd is not present to supply Vddbackup.

enumerator CY_SYSPM_VDDBACKUP_VBACKUP

Sets only Vbackup to supply Vddbackup.

enum cy_en_syspm_sc_charge_key_t

cy_en_syspm_sc_charge_key_t: This enumeration enables supercapacitor charging.

Values:

enumerator CY_SYSPM_SC_CHARGE_ENABLE

Enables supercapacitor charging.

enumerator CY_SYSPM_SC_CHARGE_DISABLE

Disables supercapacitor charging.

enum cy_en_syspm_flash_voltage_bit_t

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

Values:

enumerator CY_SYSPM_FLASH_VOLTAGE_BIT_LP

Set the flash voltage bit for system LP mode.

enumerator CY_SYSPM_FLASH_VOLTAGE_BIT_ULP

Set the flash voltage bit for system ULP mode.

enum cy_en_syspm_callback_type_t

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.

Values:

enumerator CY_SYSPM_SLEEP

The Sleep enum callback type.

enumerator CY_SYSPM_DEEPSLEEP

The Deep Sleep enum callback type.

enumerator CY_SYSPM_HIBERNATE

The Hibernate enum callback type.

enumerator CY_SYSPM_LP

The Low Power enum callback type.

enumerator CY_SYSPM_ULP

The Ultra Low Power enum callback type.

enum cy_en_syspm_callback_mode_t

cy_en_syspm_callback_mode_t: This enumeration specifies the associated callback mode.

This enum defines the callback mode.

Values:

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.

enumerator 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

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

enumerator CY_SYSPM_AFTER_TRANSITION

Performs the actions to be done after exiting the low power mode if entered.

enum cy_en_syspm_sram_index_t

cy_en_syspm_sram_index_t: This enumeration is used to select a particular SRAM.

note

This macro is available for CAT1A devices.

Values:

enumerator CY_SYSPM_SRAM0_MEMORY

SRAM0 Memory Area.

enumerator CY_SYSPM_SRAM1_MEMORY

SRAM1 Memory Area.

enumerator CY_SYSPM_SRAM2_MEMORY

SRAM2 Memory Area.

enum cy_en_syspm_sram_pwr_mode_t

cy_en_syspm_sram_pwr_mode_t: This enumeration is used to select a particular SRAM Power Mode.

Values:

enumerator CY_SYSPM_SRAM_PWR_MODE_OFF

SRAM Power Mode OFF.

enumerator CY_SYSPM_SRAM_PWR_MODE_INVALID

Invalid SRAM Power Mode.

enumerator CY_SYSPM_SRAM_PWR_MODE_RET

SRAM Power Mode RET.

enumerator CY_SYSPM_SRAM_PWR_MODE_ON

SRAM Power Mode ON.