PSoC 6 Peripheral Driver Library

General Description

Functions

__STATIC_INLINE void Cy_SysPm_BackupSetSupply (cy_en_syspm_vddbackup_control_t vddBackControl)
 Sets the backup supply (Vddback) operation mode. More...
 
__STATIC_INLINE cy_en_syspm_vddbackup_control_t Cy_SysPm_BackupGetSupply (void)
 Returns the current backup supply (Vddback) operation mode. More...
 
__STATIC_INLINE void Cy_SysPm_BackupEnableVoltageMeasurement (void)
 This function enables Vbackup supply measurement by the ADC. More...
 
__STATIC_INLINE void Cy_SysPm_BackupDisableVoltageMeasurement (void)
 The function disables Vbackup supply measurement by the ADC by disconnecting the Vbackup supply from AMuxBusA. More...
 
__STATIC_INLINE void Cy_SysPm_BackupSuperCapCharge (cy_en_syspm_sc_charge_key_t key)
 Configures the supercapacitor charger circuit. More...
 

Function Documentation

◆ Cy_SysPm_BackupSetSupply()

__STATIC_INLINE void Cy_SysPm_BackupSetSupply ( cy_en_syspm_vddbackup_control_t  vddBackControl)

Sets the backup supply (Vddback) operation mode.

Parameters
vddBackControlSelects backup supply (Vddback) operation mode. See cy_en_syspm_vddbackup_control_t.

Refer to device TRM for more detail about backup supply modes.

Function Usage
/* Scenario: There is a need to set only Vbackup to supply Vddbackup */
/* Ensure there is a valid power connection on backup pin */

◆ Cy_SysPm_BackupGetSupply()

__STATIC_INLINE cy_en_syspm_vddbackup_control_t Cy_SysPm_BackupGetSupply ( void  )

Returns the current backup supply (Vddback) operation mode.

Returns
The current backup supply (Vddback) operation mode, see cy_en_syspm_status_t.

Refer to device TRM for more detail about backup supply modes.

Function Usage
/* Scenario: There is a need to get the current backup supply (Vddback) operation mode */

◆ Cy_SysPm_BackupEnableVoltageMeasurement()

__STATIC_INLINE void Cy_SysPm_BackupEnableVoltageMeasurement ( void  )

This function enables Vbackup supply measurement by the ADC.

The function connects the Vbackup supply to AMuxBusA. The ADC input can then be connected to AMuxBusA. Note that the measured signal is scaled by 10% to allow full range measurement by the ADC.

Refer to device TRM for more detail about Vbackup supply measurement.

Function Usage
/* Scenario: There is a need to enable Vbackup supply measurement
* via AMuxBusA, e.g. by the internal ADC.
*/
/* Connect amuxbus_sar to amuxbus_main */
HSIOM->AMUX_SPLIT_CTL[6] = HSIOM_AMUX_SPLIT_CTL_SWITCH_AA_SL_Msk | HSIOM_AMUX_SPLIT_CTL_SWITCH_AA_SR_Msk;
/* Connect amuxbus_adft0_vddd to amuxbus_main */
HSIOM->AMUX_SPLIT_CTL[0] = HSIOM_AMUX_SPLIT_CTL_SWITCH_AA_SL_Msk | HSIOM_AMUX_SPLIT_CTL_SWITCH_AA_SR_Msk;
/* Connect Vddbackmeasure to AMuxBus */

◆ Cy_SysPm_BackupDisableVoltageMeasurement()

__STATIC_INLINE void Cy_SysPm_BackupDisableVoltageMeasurement ( void  )

The function disables Vbackup supply measurement by the ADC by disconnecting the Vbackup supply from AMuxBusA.

Refer to device TRM for more detail about Vbackup supply measurement.

Function Usage
/* Scenario: There is a need to disable the Vbackup supply measurement by the ADC */

◆ Cy_SysPm_BackupSuperCapCharge()

__STATIC_INLINE void Cy_SysPm_BackupSuperCapCharge ( cy_en_syspm_sc_charge_key_t  key)

Configures the supercapacitor charger circuit.

Parameters
keyPasses the key to enable or disable the supercapacitor charger circuit. See cy_en_syspm_sc_charge_key_t.
Warning
This function is used only for charging the supercapacitor. Do not use this function to charge a battery. Refer to device TRM for more detail.
Function Usage
/* Scenario: There is a need to charge the supercapacitor which will
* supply the RTC during Hibernate mode for a few hours
*/