Functions | |
cy_en_syspm_status_t | Cy_SysPm_BuckEnable (cy_en_syspm_buck_voltage1_t voltage) |
Switch the core supply regulator to Buck core regulator instead of the LDO regulator. More... | |
cy_en_syspm_status_t | Cy_SysPm_BuckSetVoltage1 (cy_en_syspm_buck_voltage1_t voltage) |
Sets the output 1 voltage for the Buck regulator that can supply the device core. More... | |
void | Cy_SysPm_BuckSetVoltage2 (cy_en_syspm_buck_voltage2_t voltage, bool waitToSettle) |
This function sets output voltage 2 (Vbuckrf) of the SIMO Buck regulator. More... | |
void | Cy_SysPm_BuckEnableVoltage2 (void) |
Enable the output 2 voltage (Vbuckrf) of the SIMO Buck regulator. More... | |
bool | Cy_SysPm_BuckIsOutputEnabled (cy_en_syspm_buck_out_t output) |
This function gets the current output status of the Buck outputs. More... | |
bool | Cy_SysPm_BuckIsEnabled (void) |
Get the current status of the Buck regulator. More... | |
cy_en_syspm_buck_voltage1_t | Cy_SysPm_BuckGetVoltage1 (void) |
Gets the current nominal output 1 voltage (Vccbuck1) of the Buck regulator. More... | |
cy_en_syspm_buck_voltage2_t | Cy_SysPm_BuckGetVoltage2 (void) |
Gets the current output 2 nominal voltage (Vbuckrf) of the SIMO Buck regulator. More... | |
void | Cy_SysPm_BuckDisableVoltage2 (void) |
Disables the output 2 voltage (Vbuckrf) of the SIMO Buck regulator. More... | |
void | Cy_SysPm_BuckSetVoltage2HwControl (bool hwControl) |
Sets the hardware control for SIMO Buck output 2 (Vbuckrf). More... | |
bool | Cy_SysPm_BuckIsVoltage2HwControlled (void) |
Returns the hardware control state for Buck output 2 (Vbuckrf). More... | |
cy_en_syspm_status_t | Cy_SysPm_CoreBuckSetVoltage (cy_en_syspm_core_buck_voltage_t voltage) |
Set the Core Buck Regulator Voltage. More... | |
cy_en_syspm_core_buck_voltage_t | Cy_SysPm_CoreBuckGetVoltage (void) |
Get the Core Buck Regulator Voltage. More... | |
void | Cy_SysPm_CoreBuckSetMode (cy_en_syspm_core_buck_mode_t mode) |
Set the Core Buck Regulator mode. More... | |
cy_en_syspm_core_buck_mode_t | Cy_SysPm_CoreBuckGetMode (void) |
Get the Core Buck Regulator Mode. More... | |
cy_en_syspm_status_t | Cy_SysPm_CoreBuckStatus (void) |
Get the status of Core Buck Regulator. More... | |
cy_en_syspm_status_t | Cy_SysPm_CoreBuckDpslpSetVoltage (cy_en_syspm_core_buck_voltage_t voltage) |
Set the Deepsleep mode Core Buck Regulator Voltage. More... | |
cy_en_syspm_core_buck_voltage_t | Cy_SysPm_CoreBuckDpslpGetVoltage (void) |
Get the Deepsleep Core Buck Regulator Voltage. More... | |
void | Cy_SysPm_CoreBuckDpslpSetMode (cy_en_syspm_core_buck_mode_t mode) |
Set the Deepsleep Core Buck Regulator mode. More... | |
cy_en_syspm_core_buck_mode_t | Cy_SysPm_CoreBuckDpslpGetMode (void) |
Get the Deepsleep Core Buck Regulator Mode. More... | |
void | Cy_SysPm_CoreBuckDpslpEnableOverride (bool enable) |
Enable the Override feature for core buck during Deepsleep. More... | |
bool | Cy_SysPm_CoreBuckDpslpIsOverrideEnabled (void) |
Checks if Override feature of core buck during deepsleep is enabled or not. More... | |
void | Cy_SysPm_CoreBuckSetProfile (cy_en_syspm_core_buck_profile_t profile) |
Set the Core Buck Regulator Profile. More... | |
cy_en_syspm_core_buck_profile_t | Cy_SysPm_CoreBuckGetProfile (void) |
Get the Core Buck Regulator Profile. More... | |
cy_en_syspm_status_t | Cy_SysPm_RetLdoStatus (void) |
Get the status of RETLDO Regulator. More... | |
cy_en_syspm_status_t | Cy_SysPm_RetLdoConfigure (cy_stc_syspm_retldo_params_t *retLdoParam) |
Configures the RETLDO Regulator. More... | |
cy_en_syspm_status_t | Cy_SysPm_SramLdoStatus (void) |
Get the status of SRAMLDO Regulator. More... | |
cy_en_syspm_status_t | Cy_SysPm_SramLdoConfigure (cy_stc_syspm_sramldo_params_t *sramLdoParam) |
Configures the SRAMLDO Regulator. More... | |
cy_en_syspm_status_t | Cy_SysPm_SramLdoEnable (bool enable) |
Enable/Disable SRAMLDO Regulator. More... | |
void | Cy_SysPm_SramLdoSetVoltage (cy_en_syspm_sramldo_voltage_t voltage) |
Set SRAM LDO Voltage. More... | |
cy_en_syspm_sramldo_voltage_t | Cy_SysPm_SramLdoGetVoltage (void) |
Get the SRAM LDO Voltage. More... | |
cy_en_syspm_status_t | Cy_SysPm_MiscLdoStatus (void) |
Get the status of MISCLDO Regulator. More... | |
cy_en_syspm_status_t | Cy_SysPm_MiscLdoConfigure (cy_stc_syspm_miscldo_params_t *miscLdoParam) |
Configures the MISCLDO Regulator. More... | |
void | Cy_SysPm_CoreBuckSetInrushLimit (cy_en_syspm_core_inrush_limit_t inrushLimit) |
Set the Core Buck Inrush Limit. More... | |
cy_en_syspm_core_inrush_limit_t | Cy_SysPm_CoreBuckGetInrushLimit (void) |
Get the Core Buck Inrush Limit. More... | |
cy_en_syspm_status_t | Cy_SysPm_CoreBuckConfig (cy_stc_syspm_core_buck_params_t *config) |
Configures the Core Buck Regulator. More... | |
cy_en_syspm_status_t | Cy_SysPm_LdoExtraRequesterConfig (cy_stc_syspm_extraReq_params_t *extraReqConfig) |
Configures the Extra Requester for Core Buck Regulator. More... | |
cy_en_syspm_status_t Cy_SysPm_BuckEnable | ( | cy_en_syspm_buck_voltage1_t | voltage | ) |
Switch the core supply regulator to Buck core regulator instead of the LDO regulator.
The Buck core regulator provides output voltage(s) using one external inductor and can supply Vccd with higher efficiency than the LDO under some conditions, such as high external supply voltage.
Before changing from LDO to Buck, ensure that the circuit board has connected Vccbuck1 to Vccd and also populated the necessary external components for the Buck regulator, including an inductor and a capacitor for each output. Refer to the device TRM for more detail.
When changing from a higher voltage to a lower voltage (from system LP = LDO 1.1 V (nominal) to system ULP = Buck 0.9 V (nominal)), ensure that:
Setting wait states values for flash
The flash access time when the core output voltage is 0.9 V (nominal) is longer than at 1.1 V (nominal). Therefore, the number of the wait states must be adjusted. Use the Cy_SysLib_SetWaitStates() function to set the appropriate wait state values for flash.
To change from a higher voltage (LDO 1.1 V) to a lower voltage (Buck 0.9 V), call the Cy_SysLib_SetWaitStates(true, hfClkFreqMz) function before changing the voltage, where hfClkFreqMz is the frequency of HfClk0 in MHz.
To change from a lower voltage (LDO 0.9 V (nominal) to a higher voltage (Buck 1.1 V (nominal)), call the Cy_SysLib_SetWaitStates(false, hfClkFreqMz) function to set the wait states after the voltage change. It is optional, but can be done to improve performance. The clock frequency may now be increased up to system LP mode limits for the new voltage.
For more detail, refer to the Switching the System into Ultra Low Power and Switching the System into Low Power sections. Refer to the SysLib (System Library) driver for more detail about setting wait states.
voltage | The desired output 1 regulator voltage (Vccbuck1). See cy_en_syspm_buck_voltage1_t. |
Function uses a critical section to prevent interrupting the regulators switch.
cy_en_syspm_status_t Cy_SysPm_BuckSetVoltage1 | ( | cy_en_syspm_buck_voltage1_t | voltage | ) |
Sets the output 1 voltage for the Buck regulator that can supply the device core.
This output can supply the device core instead of the LDO regulator.
When changing from a higher voltage 1.1 V (nominal) to a lower voltage 0.9 V (nominal), ensure that:
Setting wait states values for flash
The flash access time when the core output voltage is 0.9 V (nominal) is longer than at 1.1 V (nominal). Therefore, the number of the wait states must be adjusted. Use the Cy_SysLib_SetWaitStates() function to set the appropriate wait state values for flash.
To change from a higher voltage to a lower voltage 0.9 V (nominal), call the Cy_SysLib_SetWaitStates(true, hfClkFreqMz) function before changing the voltage, where hfClkFreqMz is the frequency of HfClk0 in MHz.
To change from a lower voltage to a higher voltage 1.1 V (nominal), call the Cy_SysLib_SetWaitStates(false, hfClkFreqMz) function to set the wait states. It is optional, but can be done to improve the performance. The clock frequency may now be increased up to LP Limitations for a new voltage.
For more detail, refer to the Switching the System into Ultra Low Power and Switching the System into Low Power sections. Refer to the SysLib (System Library) driver for more detail about setting the wait states.
voltage | The desired output 1 regulator voltage (Vccbuck1). See cy_en_syspm_buck_voltage1_t |
void Cy_SysPm_BuckSetVoltage2 | ( | cy_en_syspm_buck_voltage2_t | voltage, |
bool | waitToSettle | ||
) |
This function sets output voltage 2 (Vbuckrf) of the SIMO Buck regulator.
voltage | The voltage of the Buck regulator output 2 (Vbuckrf). See cy_en_syspm_buck_voltage2_t. |
waitToSettle |
|
void Cy_SysPm_BuckEnableVoltage2 | ( | void | ) |
Enable the output 2 voltage (Vbuckrf) of the SIMO Buck regulator.
The output 2 voltage (Vbuckrf) of the Buck regulator is typically used to supply the BLE radio. This function does following actions, when the Buck regulator does not supply the core:
bool Cy_SysPm_BuckIsOutputEnabled | ( | cy_en_syspm_buck_out_t | output | ) |
This function gets the current output status of the Buck outputs.
output | The Buck regulator output. See cy_en_syspm_buck_out_t. |
bool Cy_SysPm_BuckIsEnabled | ( | void | ) |
Get the current status of the Buck regulator.
cy_en_syspm_buck_voltage1_t Cy_SysPm_BuckGetVoltage1 | ( | void | ) |
Gets the current nominal output 1 voltage (Vccbuck1) of the Buck regulator.
cy_en_syspm_buck_voltage2_t Cy_SysPm_BuckGetVoltage2 | ( | void | ) |
Gets the current output 2 nominal voltage (Vbuckrf) of the SIMO Buck regulator.
void Cy_SysPm_BuckDisableVoltage2 | ( | void | ) |
Disables the output 2 voltage (Vbuckrf) of the SIMO Buck regulator.
The output 2 voltage (Vbuckrf) of the Buck regulator is typically used to supply the BLE radio.
This function is applicable for devices with the SIMO Buck regulator. Refer to the device datasheet for information about whether the device contains a SIMO Buck.
void Cy_SysPm_BuckSetVoltage2HwControl | ( | bool | hwControl | ) |
Sets the hardware control for SIMO Buck output 2 (Vbuckrf).
When hardware control is enabled for the Vbuckrf output, the firmware controlled enable register setting is ignored and the hardware signal is used instead. If the product has supporting hardware like BLE radio, it can directly control the enable signal for Vbuckrf.
hwControl | Enables/disables hardware control for the SIMO Buck output 2. |
Function does not have an effect if SIMO Buck regulator is disabled.
The function is applicable for devices with the SIMO Buck regulator. Refer to the device datasheet for information about whether the device contains a SIMO Buck.
bool Cy_SysPm_BuckIsVoltage2HwControlled | ( | void | ) |
Returns the hardware control state for Buck output 2 (Vbuckrf).
When hardware control is enabled for the Vbuckrf output, the firmware controlled enable register setting is ignored and the hardware signal is used instead. If the product has supporting hardware like BLE radio, it can directly control the enable signal for Vbuckrf.
The function is applicable for devices with the SIMO Buck regulator. Refer to device datasheet about information if device contains SIMO Buck.
cy_en_syspm_status_t Cy_SysPm_CoreBuckSetVoltage | ( | cy_en_syspm_core_buck_voltage_t | voltage | ) |
Set the Core Buck Regulator Voltage.
voltage | Pick from cy_en_syspm_core_buck_voltage_t |
cy_en_syspm_core_buck_voltage_t Cy_SysPm_CoreBuckGetVoltage | ( | void | ) |
Get the Core Buck Regulator Voltage.
void Cy_SysPm_CoreBuckSetMode | ( | cy_en_syspm_core_buck_mode_t | mode | ) |
Set the Core Buck Regulator mode.
mode | Pick from cy_en_syspm_core_buck_mode_t |
cy_en_syspm_core_buck_mode_t Cy_SysPm_CoreBuckGetMode | ( | void | ) |
Get the Core Buck Regulator Mode.
cy_en_syspm_status_t Cy_SysPm_CoreBuckStatus | ( | void | ) |
Get the status of Core Buck Regulator.
cy_en_syspm_status_t Cy_SysPm_CoreBuckDpslpSetVoltage | ( | cy_en_syspm_core_buck_voltage_t | voltage | ) |
Set the Deepsleep mode Core Buck Regulator Voltage.
voltage | Pick from cy_en_syspm_core_buck_voltage_t |
cy_en_syspm_core_buck_voltage_t Cy_SysPm_CoreBuckDpslpGetVoltage | ( | void | ) |
Get the Deepsleep Core Buck Regulator Voltage.
void Cy_SysPm_CoreBuckDpslpSetMode | ( | cy_en_syspm_core_buck_mode_t | mode | ) |
Set the Deepsleep Core Buck Regulator mode.
mode | Pick from cy_en_syspm_core_buck_mode_t |
cy_en_syspm_core_buck_mode_t Cy_SysPm_CoreBuckDpslpGetMode | ( | void | ) |
Get the Deepsleep Core Buck Regulator Mode.
void Cy_SysPm_CoreBuckDpslpEnableOverride | ( | bool | enable | ) |
Enable the Override feature for core buck during Deepsleep.
enable | true - enable, false - disable |
bool Cy_SysPm_CoreBuckDpslpIsOverrideEnabled | ( | void | ) |
Checks if Override feature of core buck during deepsleep is enabled or not.
void Cy_SysPm_CoreBuckSetProfile | ( | cy_en_syspm_core_buck_profile_t | profile | ) |
Set the Core Buck Regulator Profile.
profile | Pick from cy_en_syspm_core_buck_profile_t |
cy_en_syspm_core_buck_profile_t Cy_SysPm_CoreBuckGetProfile | ( | void | ) |
Get the Core Buck Regulator Profile.
cy_en_syspm_status_t Cy_SysPm_RetLdoStatus | ( | void | ) |
Get the status of RETLDO Regulator.
cy_en_syspm_status_t Cy_SysPm_RetLdoConfigure | ( | cy_stc_syspm_retldo_params_t * | retLdoParam | ) |
Configures the RETLDO Regulator.
retLdoParam | Structure containing the config parameters, cy_stc_syspm_retldo_params_t |
cy_en_syspm_status_t Cy_SysPm_SramLdoStatus | ( | void | ) |
Get the status of SRAMLDO Regulator.
cy_en_syspm_status_t Cy_SysPm_SramLdoConfigure | ( | cy_stc_syspm_sramldo_params_t * | sramLdoParam | ) |
Configures the SRAMLDO Regulator.
sramLdoParam | Structure containing the config parameters, cy_stc_syspm_sramldo_params_t |
cy_en_syspm_status_t Cy_SysPm_SramLdoEnable | ( | bool | enable | ) |
Enable/Disable SRAMLDO Regulator.
enable | true - enable, false - disable |
void Cy_SysPm_SramLdoSetVoltage | ( | cy_en_syspm_sramldo_voltage_t | voltage | ) |
Set SRAM LDO Voltage.
voltage | Enum cy_en_syspm_sramldo_voltage_t |
cy_en_syspm_sramldo_voltage_t Cy_SysPm_SramLdoGetVoltage | ( | void | ) |
Get the SRAM LDO Voltage.
cy_en_syspm_status_t Cy_SysPm_MiscLdoStatus | ( | void | ) |
Get the status of MISCLDO Regulator.
cy_en_syspm_status_t Cy_SysPm_MiscLdoConfigure | ( | cy_stc_syspm_miscldo_params_t * | miscLdoParam | ) |
Configures the MISCLDO Regulator.
miscLdoParam | Structure containing the config parameters, cy_stc_syspm_miscldo_params_t |
void Cy_SysPm_CoreBuckSetInrushLimit | ( | cy_en_syspm_core_inrush_limit_t | inrushLimit | ) |
Set the Core Buck Inrush Limit.
inrushLimit | Pick from cy_en_syspm_core_inrush_limit_t |
cy_en_syspm_core_inrush_limit_t Cy_SysPm_CoreBuckGetInrushLimit | ( | void | ) |
Get the Core Buck Inrush Limit.
cy_en_syspm_status_t Cy_SysPm_CoreBuckConfig | ( | cy_stc_syspm_core_buck_params_t * | config | ) |
Configures the Core Buck Regulator.
For information about the CBUCK control, refer to the appropriate device TRM.
config | Structure containing the config parameters, cy_stc_syspm_core_buck_params_t |
cy_en_syspm_status_t Cy_SysPm_LdoExtraRequesterConfig | ( | cy_stc_syspm_extraReq_params_t * | extraReqConfig | ) |
Configures the Extra Requester for Core Buck Regulator.
For information about the CBUCK control, refer to the appropriate device TRM.
extraReqConfig | Pointer to structure containing the extra requester config parameters, cy_stc_syspm_extraReq_params_t |