RTEMS 6.1-rc6
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Enumerator | Variables
Dcdc

Data Structures

struct  _dcdc_detection_config
 Configuration for DCDC detection. More...
 
struct  _dcdc_loop_control_config
 Configuration for the loop control. More...
 
struct  _dcdc_low_power_config
 Configuration for DCDC low power. More...
 
struct  _dcdc_internal_regulator_config
 Configuration for DCDC internal regulator. More...
 
struct  _dcdc_min_power_config
 Configuration for min power setting. More...
 

Macros

#define FSL_DCDC_DRIVER_VERSION   (MAKE_VERSION(2, 3, 0))
 DCDC driver version.
 

Typedefs

typedef enum _dcdc_comparator_current_bias dcdc_comparator_current_bias_t
 The current bias of low power comparator.
 
typedef enum _dcdc_over_current_threshold dcdc_over_current_threshold_t
 The threshold of over current detection.
 
typedef enum _dcdc_peak_current_threshold dcdc_peak_current_threshold_t
 The threshold if peak current detection.
 
typedef enum _dcdc_count_charging_time_period dcdc_count_charging_time_period_t
 The period of counting the charging times in power save mode.
 
typedef enum _dcdc_count_charging_time_threshold dcdc_count_charging_time_threshold_t
 The threshold of the counting number of charging times.
 
typedef enum _dcdc_clock_source dcdc_clock_source_t
 Oscillator clock option.
 
typedef struct _dcdc_detection_config dcdc_detection_config_t
 Configuration for DCDC detection.
 
typedef struct _dcdc_loop_control_config dcdc_loop_control_config_t
 Configuration for the loop control.
 
typedef struct _dcdc_low_power_config dcdc_low_power_config_t
 Configuration for DCDC low power.
 
typedef struct _dcdc_internal_regulator_config dcdc_internal_regulator_config_t
 Configuration for DCDC internal regulator.
 
typedef struct _dcdc_min_power_config dcdc_min_power_config_t
 Configuration for min power setting.
 

Enumerations

enum  _dcdc_status_flags_t { kDCDC_LockedOKStatus = (1U << 0U) }
 DCDC status flags. More...
 
enum  _dcdc_comparator_current_bias {
  kDCDC_ComparatorCurrentBias50nA = 0U , kDCDC_ComparatorCurrentBias100nA = 1U , kDCDC_ComparatorCurrentBias200nA = 2U , kDCDC_ComparatorCurrentBias400nA = 3U ,
  kDCDC_ComparatorCurrentBias50nA = 0U , kDCDC_ComparatorCurrentBias100nA = 1U , kDCDC_ComparatorCurrentBias200nA = 2U , kDCDC_ComparatorCurrentBias400nA = 3U
}
 The current bias of low power comparator. More...
 
enum  _dcdc_over_current_threshold { kDCDC_OverCurrentThresholdAlt0 = 0U , kDCDC_OverCurrentThresholdAlt1 = 1U , kDCDC_OverCurrentThresholdAlt2 = 2U , kDCDC_OverCurrentThresholdAlt3 = 3U }
 The threshold of over current detection. More...
 
enum  _dcdc_peak_current_threshold {
  kDCDC_PeakCurrentRunMode250mALPMode1P5A = 0U , kDCDC_PeakCurrentRunMode200mALPMode1P5A , kDCDC_PeakCurrentRunMode250mALPMode2A , kDCDC_PeakCurrentRunMode200mALPMode2A ,
  kDCDC_PeakCurrentThresholdAlt0 = 0U , kDCDC_PeakCurrentThresholdAlt1 = 1U , kDCDC_PeakCurrentThresholdAlt2 = 2U , kDCDC_PeakCurrentThresholdAlt3 = 3U ,
  kDCDC_PeakCurrentThresholdAlt4 = 4U , kDCDC_PeakCurrentThresholdAlt5 = 5U
}
 The threshold if peak current detection. More...
 
enum  _dcdc_count_charging_time_period { kDCDC_CountChargingTimePeriod8Cycle = 0U , kDCDC_CountChargingTimePeriod16Cycle = 1U }
 The period of counting the charging times in power save mode. More...
 
enum  _dcdc_count_charging_time_threshold { kDCDC_CountChargingTimeThreshold32 = 0U , kDCDC_CountChargingTimeThreshold64 = 1U , kDCDC_CountChargingTimeThreshold16 = 2U , kDCDC_CountChargingTimeThreshold8 = 3U }
 The threshold of the counting number of charging times. More...
 
enum  _dcdc_clock_source {
  kDCDC_ClockAutoSwitch = 0U , kDCDC_ClockInternalOsc = 1U , kDCDC_ClockExternalOsc = 2U , kDCDC_ClockAutoSwitch = 0U ,
  kDCDC_ClockInternalOsc = 1U , kDCDC_ClockExternalOsc = 2U
}
 Oscillator clock option. More...
 

Variables

bool _dcdc_detection_config::enableXtalokDetection
 
bool _dcdc_detection_config::powerDownOverVoltageDetection
 
bool _dcdc_detection_config::powerDownLowVlotageDetection
 
bool _dcdc_detection_config::powerDownOverCurrentDetection
 
bool _dcdc_detection_config::powerDownPeakCurrentDetection
 
bool _dcdc_detection_config::powerDownZeroCrossDetection
 
dcdc_over_current_threshold_t _dcdc_detection_config::OverCurrentThreshold
 
dcdc_peak_current_threshold_t _dcdc_detection_config::PeakCurrentThreshold
 
bool _dcdc_loop_control_config::enableCommonHysteresis
 
bool _dcdc_loop_control_config::enableCommonThresholdDetection
 
bool _dcdc_loop_control_config::enableInvertHysteresisSign
 
bool _dcdc_loop_control_config::enableRCThresholdDetection
 
uint32_t _dcdc_loop_control_config::enableRCScaleCircuit
 
uint32_t _dcdc_loop_control_config::complementFeedForwardStep
 
bool _dcdc_low_power_config::enableOverloadDetection
 
bool _dcdc_low_power_config::enableAdjustHystereticValue
 
dcdc_count_charging_time_period_t _dcdc_low_power_config::countChargingTimePeriod
 
dcdc_count_charging_time_threshold_t _dcdc_low_power_config::countChargingTimeThreshold
 
bool _dcdc_internal_regulator_config::enableLoadResistor
 
uint32_t _dcdc_internal_regulator_config::feedbackPoint
 
bool _dcdc_min_power_config::enableUseHalfFreqForContinuous
 

Initialization and deinitialization

void DCDC_Init (DCDC_Type *base)
 Enable the access to DCDC registers.
 
void DCDC_Deinit (DCDC_Type *base)
 Disable the access to DCDC registers.
 

Status

uint32_t DCDC_GetstatusFlags (DCDC_Type *base)
 Get DCDC status flags.
 

Misc control

void DCDC_SetClockSource (DCDC_Type *base, dcdc_clock_source_t clockSource)
 Configure the DCDC clock source.
 
void DCDC_GetDefaultDetectionConfig (dcdc_detection_config_t *config)
 Get the default setting for detection configuration.
 
void DCDC_SetDetectionConfig (DCDC_Type *base, const dcdc_detection_config_t *config)
 Configure the DCDC detection.
 
void DCDC_GetDefaultLowPowerConfig (dcdc_low_power_config_t *config)
 Get the default setting for low power configuration.
 
void DCDC_SetLowPowerConfig (DCDC_Type *base, const dcdc_low_power_config_t *config)
 Configure the DCDC low power.
 
void DCDC_ResetCurrentAlertSignal (DCDC_Type *base, bool enable)
 Reset current alert signal. Alert signal is generate by peak current detection.
 
void DCDC_GetDefaultLoopControlConfig (dcdc_loop_control_config_t *config)
 Get the default setting for loop control configuration.
 
void DCDC_SetLoopControlConfig (DCDC_Type *base, const dcdc_loop_control_config_t *config)
 Configure the DCDC loop control.
 
void DCDC_SetMinPowerConfig (DCDC_Type *base, const dcdc_min_power_config_t *config)
 Configure for the min power.
 
void DCDC_AdjustTargetVoltage (DCDC_Type *base, uint32_t VDDRun, uint32_t VDDStandby)
 Adjust the target voltage of VDD_SOC in run mode and low power mode.
 
void DCDC_AdjustRunTargetVoltage (DCDC_Type *base, uint32_t VDDRun)
 Adjust the target voltage of VDD_SOC in run mode.
 
void DCDC_AdjustLowPowerTargetVoltage (DCDC_Type *base, uint32_t VDDStandby)
 Adjust the target voltage of VDD_SOC in low power mode.
 
void DCDC_SetInternalRegulatorConfig (DCDC_Type *base, const dcdc_internal_regulator_config_t *config)
 Configure the DCDC internal regulator.
 

Application guideline

void DCDC_BootIntoDCM (DCDC_Type *base)
 Boot DCDC into DCM(discontinous conduction mode).
 
void DCDC_BootIntoCCM (DCDC_Type *base)
 Boot DCDC into CCM(continous conduction mode).
 

Detailed Description

Macro Definition Documentation

◆ FSL_DCDC_DRIVER_VERSION

#define FSL_DCDC_DRIVER_VERSION   (MAKE_VERSION(2, 3, 0))

DCDC driver version.

Version 2.3.0.

Enumeration Type Documentation

◆ _dcdc_clock_source

Oscillator clock option.

Enumerator
kDCDC_ClockAutoSwitch 

Automatic clock switch from internal oscillator to external clock.

kDCDC_ClockInternalOsc 

Use internal oscillator.

kDCDC_ClockExternalOsc 

Use external 24M crystal oscillator.

kDCDC_ClockAutoSwitch 

Automatic clock switch from internal oscillator to external clock.

kDCDC_ClockInternalOsc 

Use internal oscillator.

kDCDC_ClockExternalOsc 

Use external 24M crystal oscillator.

◆ _dcdc_comparator_current_bias

The current bias of low power comparator.

Enumerator
kDCDC_ComparatorCurrentBias50nA 

The current bias of low power comparator is 50nA.

kDCDC_ComparatorCurrentBias100nA 

The current bias of low power comparator is 100nA.

kDCDC_ComparatorCurrentBias200nA 

The current bias of low power comparator is 200nA.

kDCDC_ComparatorCurrentBias400nA 

The current bias of low power comparator is 400nA.

kDCDC_ComparatorCurrentBias50nA 

The current bias of low power comparator is 50nA.

kDCDC_ComparatorCurrentBias100nA 

The current bias of low power comparator is 100nA.

kDCDC_ComparatorCurrentBias200nA 

The current bias of low power comparator is 200nA.

kDCDC_ComparatorCurrentBias400nA 

The current bias of low power comparator is 400nA.

◆ _dcdc_count_charging_time_period

The period of counting the charging times in power save mode.

Enumerator
kDCDC_CountChargingTimePeriod8Cycle 

Eight 32k cycle.

kDCDC_CountChargingTimePeriod16Cycle 

Sixteen 32k cycle.

◆ _dcdc_count_charging_time_threshold

The threshold of the counting number of charging times.

Enumerator
kDCDC_CountChargingTimeThreshold32 

0x0: 32.

kDCDC_CountChargingTimeThreshold64 

0x1: 64.

kDCDC_CountChargingTimeThreshold16 

0x2: 16.

kDCDC_CountChargingTimeThreshold8 

0x3: 8.

◆ _dcdc_over_current_threshold

The threshold of over current detection.

Enumerator
kDCDC_OverCurrentThresholdAlt0 

1A in the run mode, 0.25A in the power save mode.

kDCDC_OverCurrentThresholdAlt1 

2A in the run mode, 0.25A in the power save mode.

kDCDC_OverCurrentThresholdAlt2 

1A in the run mode, 0.2A in the power save mode.

kDCDC_OverCurrentThresholdAlt3 

2A in the run mode, 0.2A in the power save mode.

◆ _dcdc_peak_current_threshold

The threshold if peak current detection.

Enumerator
kDCDC_PeakCurrentRunMode250mALPMode1P5A 

Over peak current threshold in low power mode is 250mA, in run mode is 1.5A

kDCDC_PeakCurrentRunMode200mALPMode1P5A 

Over peak current threshold in low power mode is 200mA, in run mode is 1.5A

kDCDC_PeakCurrentRunMode250mALPMode2A 

Over peak current threshold in low power mode is 250mA, in run mode is 2A

kDCDC_PeakCurrentRunMode200mALPMode2A 

Over peak current threshold in low power mode is 200mA, in run mode is 2A

kDCDC_PeakCurrentThresholdAlt0 

150mA peak current threshold.

kDCDC_PeakCurrentThresholdAlt1 

250mA peak current threshold.

kDCDC_PeakCurrentThresholdAlt2 

350mA peak current threshold.

kDCDC_PeakCurrentThresholdAlt3 

450mA peak current threshold.

kDCDC_PeakCurrentThresholdAlt4 

550mA peak current threshold.

kDCDC_PeakCurrentThresholdAlt5 

650mA peak current threshold.

◆ _dcdc_status_flags_t

DCDC status flags.

Enumerator
kDCDC_LockedOKStatus 

Indicate DCDC status. 1'b1: DCDC already settled 1'b0: DCDC is settling.

Function Documentation

◆ DCDC_AdjustLowPowerTargetVoltage()

void DCDC_AdjustLowPowerTargetVoltage ( DCDC_Type base,
uint32_t  VDDStandby 
)

Adjust the target voltage of VDD_SOC in low power mode.

This function is to adjust the target voltage of DCDC output. Change them and finally wait until the output is stabled. Set the target value of run mode the same as low power mode before entering power save mode, because DCDC will switch back to run mode if it detects the current loading is larger than about 50 mA(typical value).

Parameters
baseDCDC peripheral base address.
VDDStandbyTarget value in low power mode. 25 mV each step from 0x00 to 0x4. 00 is for 0.9V, 0x4 is for 1.0V.

brief Adjust the target voltage of VDD_SOC in low power mode.

This function is to adjust the target voltage of DCDC output. Change them and finally wait until the output is stabled. Set the target value of run mode the same as low power mode before entering power save mode, because DCDC will switch back to run mode if it detects the current loading is larger than about 50 mA(typical value).

param base DCDC peripheral base address. param VDDStandby Target value in low power mode. 25 mV each step from 0x00 to 0x4. 00 is for 0.9V, 0x4 is for 1.0V.

◆ DCDC_AdjustRunTargetVoltage()

void DCDC_AdjustRunTargetVoltage ( DCDC_Type base,
uint32_t  VDDRun 
)

Adjust the target voltage of VDD_SOC in run mode.

This function is to adjust the target voltage of DCDC output. Change them and finally wait until the output is stabled. Set the target value of run mode the same as low power mode before entering power save mode, because DCDC will switch back to run mode if it detects the current loading is larger than about 50 mA(typical value).

Parameters
baseDCDC peripheral base address.
VDDRunTarget value in run mode. 25 mV each step from 0x00 to 0x1F. 00 is for 0.8V, 0x1F is for 1.575V.

brief Adjust the target voltage of VDD_SOC in run mode.

This function is to adjust the target voltage of DCDC output. Change them and finally wait until the output is stabled. Set the target value of run mode the same as low power mode before entering power save mode, because DCDC will switch back to run mode if it detects the current loading is larger than about 50 mA(typical value).

param base DCDC peripheral base address. param VDDRun Target value in run mode. 25 mV each step from 0x00 to 0x1F. 00 is for 0.8V, 0x1F is for 1.575V.

◆ DCDC_AdjustTargetVoltage()

void DCDC_AdjustTargetVoltage ( DCDC_Type base,
uint32_t  VDDRun,
uint32_t  VDDStandby 
)

Adjust the target voltage of VDD_SOC in run mode and low power mode.

Deprecated:
Do not use this function. It has been superceded by DCDC_AdjustRunTargetVoltage and DCDC_AdjustLowPowerTargetVoltage

This function is to adjust the target voltage of DCDC output. Change them and finally wait until the output is stabled. Set the target value of run mode the same as low power mode before entering power save mode, because DCDC will switch back to run mode if it detects the current loading is larger than about 50 mA(typical value).

Parameters
baseDCDC peripheral base address.
VDDRunTarget value in run mode. 25 mV each step from 0x00 to 0x1F. 00 is for 0.8V, 0x1F is for 1.575V.
VDDStandbyTarget value in low power mode. 25 mV each step from 0x00 to 0x4. 00 is for 0.9V, 0x4 is for 1.0V.

brief Adjust the target voltage of VDD_SOC in run mode and low power mode. Do not use this function. It has been superceded by DCDC_AdjustRunTargetVoltage and DCDC_AdjustLowPowerTargetVoltage

This function is to adjust the target voltage of DCDC output. Change them and finally wait until the output is stabled. Set the target value of run mode the same as low power mode before entering power save mode, because DCDC will switch back to run mode if it detects the current loading is larger than about 50 mA(typical value).

param base DCDC peripheral base address. param VDDRun Target value in run mode. 25 mV each step from 0x00 to 0x1F. 00 is for 0.8V, 0x1F is for 1.575V. param VDDStandby Target value in low power mode. 25 mV each step from 0x00 to 0x4. 00 is for 0.9V, 0x4 is for 1.0V.

◆ DCDC_BootIntoCCM()

void DCDC_BootIntoCCM ( DCDC_Type base)

Boot DCDC into CCM(continous conduction mode).

pwd_zcd=0x1; pwd_cmp_offset=0x0; dcdc_loopctrl_en_rcscale=0x3;

Parameters
baseDCDC peripheral base address.

Boot DCDC into CCM(continous conduction mode).

brief Boots DCDC into CCM(continous conduction mode).

pwd_zcd=0x1; pwd_cmp_offset=0x0; dcdc_loopctrl_en_rcscale=0x3;

param base DCDC peripheral base address.

Boot DCDC into CCM(continous conduction mode).

brief Boot DCDC into CCM(continous conduction mode).

pwd_zcd=0x1; pwd_cmp_offset=0x0; dcdc_loopctrl_en_rcscale=0x3;

param base DCDC peripheral base address.

◆ DCDC_BootIntoDCM()

void DCDC_BootIntoDCM ( DCDC_Type base)

Boot DCDC into DCM(discontinous conduction mode).

pwd_zcd=0x0; pwd_cmp_offset=0x0; dcdc_loopctrl_en_rcscale= 0x5; DCM_set_ctrl=1'b1;

Parameters
baseDCDC peripheral base address.

Boot DCDC into DCM(discontinous conduction mode).

brief Boots DCDC into DCM(discontinous conduction mode).

pwd_zcd=0x0; DM_CTRL = 1'b1; pwd_cmp_offset=0x0; dcdc_loopctrl_en_rcscale=0x3 or 0x5; DCM_set_ctrl=1'b1;

param base DCDC peripheral base address.

Boot DCDC into DCM(discontinous conduction mode).

brief Boot DCDC into DCM(discontinous conduction mode).

pwd_zcd=0x0; pwd_cmp_offset=0x0; dcdc_loopctrl_en_rcscale= 0x5; DCM_set_ctrl=1'b1;

param base DCDC peripheral base address.

◆ DCDC_Deinit()

void DCDC_Deinit ( DCDC_Type base)

Disable the access to DCDC registers.

Parameters
baseDCDC peripheral base address.

Disable the access to DCDC registers.

brief De-initializes the DCDC module.

param base DCDC peripheral base address.

Disable the access to DCDC registers.

brief Disable the access to DCDC registers.

param base DCDC peripheral base address.

◆ DCDC_GetDefaultDetectionConfig()

void DCDC_GetDefaultDetectionConfig ( dcdc_detection_config_t config)

Get the default setting for detection configuration.

The default configuration are set according to responding registers' setting when powered on. They are:

config->enableXtalokDetection = false;
config->powerDownOverVoltageDetection = true;
config->powerDownLowVlotageDetection = false;
config->powerDownOverCurrentDetection = true;
config->powerDownPeakCurrentDetection = true;
config->powerDownZeroCrossDetection = true;
config->OverCurrentThreshold = kDCDC_OverCurrentThresholdAlt0;
config->PeakCurrentThreshold = kDCDC_PeakCurrentThresholdAlt0;
@ kDCDC_PeakCurrentThresholdAlt0
Definition: fsl_dcdc.h:60
@ kDCDC_OverCurrentThresholdAlt0
Definition: fsl_dcdc.h:49
Definition: deflate.c:114
Parameters
configPointer to configuration structure. See to "dcdc_detection_config_t"

Get the default setting for detection configuration.

brief Gets the default setting for detection configuration.

The default configuration are set according to responding registers' setting when powered on. They are: code config->enableXtalokDetection = false; config->powerDownOverVoltageVdd1P8Detection = true; config->powerDownOverVoltageVdd1P0Detection = true; config->powerDownLowVoltageDetection = false; config->powerDownOverCurrentDetection = true; config->powerDownPeakCurrentDetection = true; config->powerDownZeroCrossDetection = true; config->PeakCurrentThreshold = kDCDC_PeakCurrentRunMode250mALPMode1P5A; endcode

param config Pointer to configuration structure. See to "dcdc_detection_config_t"

Get the default setting for detection configuration.

brief Get the default setting for detection configuration.

The default configuration are set according to responding registers' setting when powered on. They are: code config->enableXtalokDetection = false; config->powerDownOverVoltageDetection = true; config->powerDownLowVlotageDetection = false; config->powerDownOverCurrentDetection = true; config->powerDownPeakCurrentDetection = true; config->powerDownZeroCrossDetection = true; config->OverCurrentThreshold = kDCDC_OverCurrentThresholdAlt0; config->PeakCurrentThreshold = kDCDC_PeakCurrentThresholdAlt0; endcode

param config Pointer to configuration structure. See to "dcdc_detection_config_t"

◆ DCDC_GetDefaultLoopControlConfig()

void DCDC_GetDefaultLoopControlConfig ( dcdc_loop_control_config_t config)

Get the default setting for loop control configuration.

The default configuration are set according to responding registers' setting when powered on. They are:

config->enableCommonHysteresis = false;
config->enableCommonThresholdDetection = false;
config->enableInvertHysteresisSign = false;
config->enableRCThresholdDetection = false;
config->enableRCScaleCircuit = 0U;
config->complementFeedForwardStep = 0U;
Parameters
configPointer to configuration structure. See to "dcdc_loop_control_config_t"

Get the default setting for loop control configuration.

brief Gets the default setting for loop control configuration.

The default configuration are set according to responding registers' setting when powered on. They are: code config->enableCommonHysteresis = false; config->enableCommonThresholdDetection = false; config->enableInvertHysteresisSign = false; config->enableRCThresholdDetection = false; config->enableRCScaleCircuit = 0U; config->complementFeedForwardStep = 0U; config->controlParameterMagnitude = 2U; config->integralProportionalRatio = 2U; endcode

param config Pointer to configuration structure. See to "dcdc_loop_control_config_t"

Get the default setting for loop control configuration.

brief Get the default setting for loop control configuration.

The default configuration are set according to responding registers' setting when powered on. They are: code config->enableCommonHysteresis = false; config->enableCommonThresholdDetection = false; config->enableInvertHysteresisSign = false; config->enableRCThresholdDetection = false; config->enableRCScaleCircuit = 0U; config->complementFeedForwardStep = 0U; endcode

param config Pointer to configuration structure. See to "dcdc_loop_control_config_t"

◆ DCDC_GetDefaultLowPowerConfig()

void DCDC_GetDefaultLowPowerConfig ( dcdc_low_power_config_t config)

Get the default setting for low power configuration.

The default configuration are set according to responding registers' setting when powered on. They are:

config->enableOverloadDetection = true;
config->enableAdjustHystereticValue = false;
config->countChargingTimePeriod = kDCDC_CountChargingTimePeriod8Cycle;
config->countChargingTimeThreshold = kDCDC_CountChargingTimeThreshold32;
@ kDCDC_CountChargingTimePeriod8Cycle
Definition: fsl_dcdc.h:73
@ kDCDC_CountChargingTimeThreshold32
Definition: fsl_dcdc.h:82
Parameters
configPointer to configuration structure. See to "dcdc_low_power_config_t"

Get the default setting for low power configuration.

brief Gets the default setting for low power configuration.

The default configuration are set according to responding registers' setting when powered on. They are: code config->enableAdjustHystereticValue = false; endcode

param config Pointer to configuration structure. See to "dcdc_low_power_config_t"

Get the default setting for low power configuration.

brief Get the default setting for low power configuration.

The default configuration are set according to responding registers' setting when powered on. They are: code config->enableOverloadDetection = true; config->enableAdjustHystereticValue = false; config->countChargingTimePeriod = kDCDC_CountChargingTimePeriod8Cycle; config->countChargingTimeThreshold = kDCDC_CountChargingTimeThreshold32; endcode

param config Pointer to configuration structure. See to "dcdc_low_power_config_t"

◆ DCDC_GetstatusFlags()

uint32_t DCDC_GetstatusFlags ( DCDC_Type base)

Get DCDC status flags.

Parameters
baseperipheral base address.
Returns
Mask of asserted status flags. See to "_dcdc_status_flags_t".

brief Get DCDC status flags.

param base peripheral base address. return Mask of asserted status flags. See to "_dcdc_status_flags_t".

◆ DCDC_Init()

void DCDC_Init ( DCDC_Type base)

Enable the access to DCDC registers.

Parameters
baseDCDC peripheral base address.

brief Enable the access to DCDC registers.

param base DCDC peripheral base address.

◆ DCDC_ResetCurrentAlertSignal()

void DCDC_ResetCurrentAlertSignal ( DCDC_Type base,
bool  enable 
)

Reset current alert signal. Alert signal is generate by peak current detection.

Parameters
baseDCDC peripheral base address.
enableSwitcher to reset signal. True means reset signal. False means don't reset signal.

brief Reset current alert signal. Alert signal is generate by peak current detection.

param base DCDC peripheral base address. param enable Switcher to reset signal. True means reset signal. False means don't reset signal.

◆ DCDC_SetClockSource()

void DCDC_SetClockSource ( DCDC_Type base,
dcdc_clock_source_t  clockSource 
)

Configure the DCDC clock source.

Parameters
baseDCDC peripheral base address.
clockSourceClock source for DCDC. See to "dcdc_clock_source_t".

Configure the DCDC clock source.

brief Configures the DCDC clock source.

param base DCDC peripheral base address. param clockSource Clock source for DCDC. See to "dcdc_clock_source_t".

Configure the DCDC clock source.

brief Configure the DCDC clock source.

param base DCDC peripheral base address. param clockSource Clock source for DCDC. See to "dcdc_clock_source_t".

◆ DCDC_SetDetectionConfig()

void DCDC_SetDetectionConfig ( DCDC_Type base,
const dcdc_detection_config_t config 
)

Configure the DCDC detection.

Parameters
baseDCDC peripheral base address.
configPointer to configuration structure. See to "dcdc_detection_config_t"

Configure the DCDC detection.

breif Configures the DCDC detection.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_detection_config_t"

Configure the DCDC detection.

breif Configure the DCDC detection.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_detection_config_t"

◆ DCDC_SetInternalRegulatorConfig()

void DCDC_SetInternalRegulatorConfig ( DCDC_Type base,
const dcdc_internal_regulator_config_t config 
)

Configure the DCDC internal regulator.

Parameters
baseDCDC peripheral base address.
configPointer to configuration structure. See to "dcdc_internal_regulator_config_t".

Configure the DCDC internal regulator.

brief Configures the DCDC internal regulator.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_internal_regulator_config_t".

Configure the DCDC internal regulator.

brief Configure the DCDC internal regulator.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_internal_regulator_config_t".

◆ DCDC_SetLoopControlConfig()

void DCDC_SetLoopControlConfig ( DCDC_Type base,
const dcdc_loop_control_config_t config 
)

Configure the DCDC loop control.

Parameters
baseDCDC peripheral base address.
configPointer to configuration structure. See to "dcdc_loop_control_config_t".

Configure the DCDC loop control.

brief Configures the DCDC loop control.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_loop_control_config_t".

Configure the DCDC loop control.

brief Configure the DCDC loop control.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_loop_control_config_t".

◆ DCDC_SetLowPowerConfig()

void DCDC_SetLowPowerConfig ( DCDC_Type base,
const dcdc_low_power_config_t config 
)

Configure the DCDC low power.

Parameters
baseDCDC peripheral base address.
configPointer to configuration structure. See to "dcdc_low_power_config_t".

Configure the DCDC low power.

brief Configures the DCDC low power.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_low_power_config_t".

Configure the DCDC low power.

brief Configure the DCDC low power.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_low_power_config_t".

◆ DCDC_SetMinPowerConfig()

void DCDC_SetMinPowerConfig ( DCDC_Type base,
const dcdc_min_power_config_t config 
)

Configure for the min power.

Parameters
baseDCDC peripheral base address.
configPointer to configuration structure. See to "dcdc_min_power_config_t".

Configure for the min power.

brief Configures for the min power.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_min_power_config_t".

Configure for the min power.

brief Configure for the min power.

param base DCDC peripheral base address. param config Pointer to configuration structure. See to "dcdc_min_power_config_t".

Variable Documentation

◆ complementFeedForwardStep

uint32_t _dcdc_loop_control_config::complementFeedForwardStep

Available range is 0~7. Two's complement feed forward step in duty cycle in the switching DC-DC converter. Each time this field makes a transition from 0x0, the loop filter of the DC-DC converter is stepped once by a value proportional to the change. This can be used to force a certain control loop behavior, such as improving response under known heavy load transients.

◆ countChargingTimePeriod

dcdc_count_charging_time_period_t _dcdc_low_power_config::countChargingTimePeriod

The period of counting the charging times in power save mode.

◆ countChargingTimeThreshold

dcdc_count_charging_time_threshold_t _dcdc_low_power_config::countChargingTimeThreshold

the threshold of the counting number of charging times during the period that lp_overload_freq_sel sets in power save mode.

◆ enableAdjustHystereticValue

bool _dcdc_low_power_config::enableAdjustHystereticValue

Adjust hysteretic value in low power from 12.5mV to 25mV.

◆ enableCommonHysteresis

bool _dcdc_loop_control_config::enableCommonHysteresis

Enable hysteresis in switching converter common mode analog comparators. This feature will improve transient supply ripple and efficiency.

◆ enableCommonThresholdDetection

bool _dcdc_loop_control_config::enableCommonThresholdDetection

Increase the threshold detection for common mode analog comparator.

◆ enableInvertHysteresisSign

bool _dcdc_loop_control_config::enableInvertHysteresisSign

Invert the sign of the hysteresis in DC-DC analog comparators.

◆ enableLoadResistor

bool _dcdc_internal_regulator_config::enableLoadResistor

control the load resistor of the internal regulator of DCDC, the load resistor is connected as default "true", and need set to "false" to disconnect the load resistor.

◆ enableOverloadDetection

bool _dcdc_low_power_config::enableOverloadDetection

Enable the overload detection in power save mode, if current is larger than the overloading threshold (typical value is 50 mA), DCDC will switch to the run mode automatically.

◆ enableRCScaleCircuit

uint32_t _dcdc_loop_control_config::enableRCScaleCircuit

Available range is 0~7. Enable analog circuit of DC-DC converter to respond faster under transient load conditions.

◆ enableRCThresholdDetection

bool _dcdc_loop_control_config::enableRCThresholdDetection

Increase the threshold detection for RC scale circuit.

◆ enableUseHalfFreqForContinuous

bool _dcdc_min_power_config::enableUseHalfFreqForContinuous

Set DCDC clock to half frequency for the continuous mode.

◆ enableXtalokDetection

bool _dcdc_detection_config::enableXtalokDetection

Enable xtalok detection circuit.

◆ feedbackPoint

uint32_t _dcdc_internal_regulator_config::feedbackPoint

Available range is 0~3. Select the feedback point of the internal regulator.

◆ OverCurrentThreshold

dcdc_over_current_threshold_t _dcdc_detection_config::OverCurrentThreshold

The threshold of over current detection.

◆ PeakCurrentThreshold

dcdc_peak_current_threshold_t _dcdc_detection_config::PeakCurrentThreshold

The threshold of peak current detection.

◆ powerDownLowVlotageDetection

bool _dcdc_detection_config::powerDownLowVlotageDetection

Power down low-voltage detection comparator.

◆ powerDownOverCurrentDetection

bool _dcdc_detection_config::powerDownOverCurrentDetection

Power down over-current detection.

◆ powerDownOverVoltageDetection

bool _dcdc_detection_config::powerDownOverVoltageDetection

Power down over-voltage detection comparator.

◆ powerDownPeakCurrentDetection

bool _dcdc_detection_config::powerDownPeakCurrentDetection

Power down peak-current detection.

◆ powerDownZeroCrossDetection

bool _dcdc_detection_config::powerDownZeroCrossDetection

Power down the zero cross detection function for discontinuous conductor mode.