![]() |
MCUXpresso SDK API Reference Manual
Rev 2.16.000
NXP Semiconductors
|
The MCUXpresso SDK provides APIs for MCUXpresso SDK device's src operation.
The Power Management Unit(PMU) is designed to simplify the external power interface. Based on the features of PMU, the PMU driver is divided into 3 groups. In the function group "LDOs Control APIs", those APIs can be used to control LDOs (including PLL LDO, LPSR_DIG LDO, LPSR_ANA LDO) in software mode or hardware mode; In the function group "Bandgap Control APIs", those APIs can be used to control bandgap in software mode or hardware mode; In the function group "Body Bias Control APIs", those APIs can be used to control well bias and body bias in software mode or hardware mode.
Data Structures | |
struct | pmu_static_aon_ana_ldo_config_t |
AON ANA LDO config. More... | |
struct | pmu_static_aon_dig_config_t |
AON DIG LDO Config in Static/Software Mode. More... | |
struct | pmu_bbsm_dig_config_t |
BBSM DIG LDO config. More... | |
struct | pmu_static_bandgap_config_t |
Bandgap config in static mode. More... | |
union | pmu_well_bias_option_t |
The union of well bias basic options, such as clock source, power source and so on. More... | |
struct | pmu_well_bias_config_t |
The structure of well bias configuration. More... | |
Driver version | |
#define | FSL_PMU_DRIVER_VERSION (MAKE_VERSION(2, 1, 2)) |
PMU driver version. More... | |
LDOs Control APIs | |
void | PMU_SetPllLdoControlMode (ANADIG_PMU_Type *base, pmu_control_mode_t mode) |
brief Selects the control mode of the PLL LDO. More... | |
void | PMU_StaticEnablePllLdo (ANADIG_PMU_Type *base) |
Enables PLL LDO via AI interface in Static/Software mode. More... | |
void | PMU_StaticDisablePllLdo (void) |
Disables PLL LDO via AI interface in Static/Software mode. | |
void | PMU_StaticGetAonAnaLdoDefaultConfig (pmu_static_aon_ana_ldo_config_t *config) |
Fill the AON ANA LDO configuration structure with default settings. More... | |
void | PMU_StaticAonAnaLdoInit (ANADIG_LDO_BBSM_Type *base, const pmu_static_aon_ana_ldo_config_t *config) |
Initialize the AON ANA LDO in Static/Sofware Mode. More... | |
void | PMU_StaticAonAnaLdoDeinit (ANADIG_LDO_BBSM_Type *base) |
Disable the output of AON ANA LDO. More... | |
void | PMU_StaticGetAonDigLdoDefaultConfig (pmu_static_aon_dig_config_t *config) |
Gets the default configuration of AON DIG LDO. More... | |
void | PMU_StaticAonDigLdoInit (ANADIG_LDO_BBSM_Type *base, const pmu_static_aon_dig_config_t *config) |
Initialize the AON DIG LDO in static mode. More... | |
void | PMU_StaticAonDigLdoDeinit (ANADIG_LDO_BBSM_Type *base) |
Disable the AON DIG LDO. More... | |
void | PMU_GetBbsmDigLdoDefaultConfig (pmu_bbsm_dig_config_t *config) |
Gets the default config of the BBSM DIG LDO. More... | |
void | PMU_EnableLdoStandbyMode (pmu_ldo_name_t name, bool enable) |
brief When STBY assert, enable/disable the selected LDO enter it's Low power mode. More... | |
Bandgap Control APIs | |
void | PMU_DisableBandgapSelfBiasAfterPowerUp (void) |
Disables Bandgap self bias for best noise performance. More... | |
void | PMU_EnableBandgapSelfBiasBeforePowerDown (void) |
Enables Bandgap self bias before power down. More... | |
void | PMU_StaticBandgapInit (const pmu_static_bandgap_config_t *config) |
Initialize Bandgap. More... | |
Body Bias Control APIs | |
void | PMU_WellBiasInit (ANADIG_PMU_Type *base, const pmu_well_bias_config_t *config) |
Configures Well bias, such as power source, clock source and so on. More... | |
void | PMU_GetWellBiasDefaultConfig (pmu_well_bias_config_t *config) |
Gets the default configuration of well bias. More... | |
void | PMU_EnableFBB (ANADIG_PMU_Type *base, bool enable) |
brief Enables/disables FBB. More... | |
void | PMU_EnableFBBStandbyMode (ANADIG_PMU_Type *base, bool enable) |
brief Controls the ON/OFF of FBB when GPC send standby request. More... | |
struct pmu_static_aon_ana_ldo_config_t |
Data Fields | |
pmu_ldo_operate_mode_t | mode |
The operate mode of AON ANA LDO. More... | |
bool | enable2mALoad |
Enable/Disable 2mA load. More... | |
bool | enable4mALoad |
Enable/Disable 4mA load. More... | |
bool | enable20uALoad |
Enable/Disable 20uA load. More... | |
bool | enableStandbyMode |
Enable/Disable Standby Mode. More... | |
pmu_ldo_operate_mode_t pmu_static_aon_ana_ldo_config_t::mode |
bool pmu_static_aon_ana_ldo_config_t::enable2mALoad |
bool pmu_static_aon_ana_ldo_config_t::enable4mALoad |
bool pmu_static_aon_ana_ldo_config_t::enable20uALoad |
bool pmu_static_aon_ana_ldo_config_t::enableStandbyMode |
struct pmu_static_aon_dig_config_t |
Data Fields | |
bool | enableStableDetect |
Enable/Disable Stable Detect. More... | |
pmu_aon_dig_voltage_step_time_t | voltageStepTime |
Step time. More... | |
pmu_aon_dig_target_output_voltage_t | targetVoltage |
The target output voltage. More... | |
bool pmu_static_aon_dig_config_t::enableStableDetect |
pmu_aon_dig_voltage_step_time_t pmu_static_aon_dig_config_t::voltageStepTime |
pmu_aon_dig_target_output_voltage_t pmu_static_aon_dig_config_t::targetVoltage |
struct pmu_bbsm_dig_config_t |
Data Fields | |
pmu_ldo_operate_mode_t | mode |
The operate mode the BBSM DIG LDO. More... | |
pmu_bbsm_dig_charge_pump_current_t | chargePumpCurrent |
The current of BBSM DIG LDO's charge pump current. More... | |
pmu_bbsm_dig_discharge_resistor_value_t | dischargeResistorValue |
The value of BBSM DIG LDO's Discharge Resistor. More... | |
uint8_t | trimValue |
The trim value. More... | |
bool | enablePullDown |
Enable/Disable Pull down. More... | |
bool | enableLdoStable |
Enable/Disable BBSM DIG LDO Stable. More... | |
pmu_ldo_operate_mode_t pmu_bbsm_dig_config_t::mode |
pmu_bbsm_dig_charge_pump_current_t pmu_bbsm_dig_config_t::chargePumpCurrent |
pmu_bbsm_dig_discharge_resistor_value_t pmu_bbsm_dig_config_t::dischargeResistorValue |
uint8_t pmu_bbsm_dig_config_t::trimValue |
bool pmu_bbsm_dig_config_t::enablePullDown |
bool pmu_bbsm_dig_config_t::enableLdoStable |
struct pmu_static_bandgap_config_t |
Data Fields | |
uint8_t | powerDownOption |
The OR'ed value of _pmu_static_bandgap_power_down_option. More... | |
bool | enableLowPowerMode |
Turn on/off the Low power mode. More... | |
pmu_bandgap_output_VBG_voltage_value_t | outputVoltage |
The output VBG voltage of Bandgap. More... | |
pmu_bandgap_output_current_value_t | outputCurrent |
The output current from the bandgap to the temperature sensors. More... | |
uint8_t pmu_static_bandgap_config_t::powerDownOption |
Please refer to _pmu_static_bandgap_power_down_option.
bool pmu_static_bandgap_config_t::enableLowPowerMode |
pmu_bandgap_output_VBG_voltage_value_t pmu_static_bandgap_config_t::outputVoltage |
pmu_bandgap_output_current_value_t pmu_static_bandgap_config_t::outputCurrent |
union pmu_well_bias_option_t |
Data Fields | |
uint16_t | wellBiasData |
well bias configuration data. More... | |
uint16_t | enablePWellOnly: 1U |
Turn on both PWELL and NWELL, or only trun on PWELL. More... | |
uint16_t | reserved1: 1U |
Reserved. More... | |
uint16_t | biasAreaSize: 3U |
Select size of bias area, please refer to pmu_bias_area_size_t. | |
uint16_t | disableAdaptiveFreq: 1U |
Enable/Disable adaptive frequency. More... | |
uint16_t | wellBiasFreq: 3U |
Set well bias typical frequency, please refer to pmu_well_bias_typical_freq_t. More... | |
uint16_t | clkSource: 1U |
Config the adaptive clock source, please pmu_adaptive_clock_source_t. More... | |
uint16_t | freqReduction: 2U |
Config the percent of frequency reduction due to cap increment, please refer to pmu_freq_reduction_t. More... | |
uint16_t | enablePullDownOption: 1U |
Enable/Disable pull down option. More... | |
uint16_t | reserved2: 1U |
Reserved. More... | |
uint16_t | powerSource: 1U |
Set power source, please refer to pmu_well_bias_power_source_t. More... | |
uint16_t | reserved3: 1U |
Reserved. More... | |
uint16_t pmu_well_bias_option_t::wellBiasData |
uint16_t pmu_well_bias_option_t::enablePWellOnly |
uint16_t pmu_well_bias_option_t::reserved1 |
uint16_t pmu_well_bias_option_t::disableAdaptiveFreq |
uint16_t pmu_well_bias_option_t::wellBiasFreq |
uint16_t pmu_well_bias_option_t::clkSource |
uint16_t pmu_well_bias_option_t::freqReduction |
uint16_t pmu_well_bias_option_t::enablePullDownOption |
uint16_t pmu_well_bias_option_t::reserved2 |
uint16_t pmu_well_bias_option_t::powerSource |
uint16_t pmu_well_bias_option_t::reserved3 |
struct pmu_well_bias_config_t |
Data Fields | |
pmu_well_bias_option_t | wellBiasOption |
Well bias basic function, please refer to pmu_well_bias_option_t. More... | |
pmu_well_bias_1P8_adjustment_t | adjustment |
Well bias adjustment 1P8, please refer to pmu_well_bias_1P8_adjustment_t. More... | |
pmu_well_bias_option_t pmu_well_bias_config_t::wellBiasOption |
pmu_well_bias_1P8_adjustment_t pmu_well_bias_config_t::adjustment |
#define FSL_PMU_DRIVER_VERSION (MAKE_VERSION(2, 1, 2)) |
Version 2.1.2.
enum pmu_ldo_name_t |
enum pmu_control_mode_t |
enum pmu_bias_area_size_t |
enum pmu_freq_reduction_t |
void PMU_SetPllLdoControlMode | ( | ANADIG_PMU_Type * | base, |
pmu_control_mode_t | mode | ||
) |
param base PMU peripheral base address. param mode The control mode of the PLL LDO. Please refer to pmu_control_mode_t.
void PMU_StaticEnablePllLdo | ( | ANADIG_PMU_Type * | base | ) |
base | PMU peripheral base address. |
void PMU_StaticGetAonAnaLdoDefaultConfig | ( | pmu_static_aon_ana_ldo_config_t * | config | ) |
The default values are:
config | Pointer to the structure pmu_static_aon_ana_ldo_config_t. |
void PMU_StaticAonAnaLdoInit | ( | ANADIG_LDO_BBSM_Type * | base, |
const pmu_static_aon_ana_ldo_config_t * | config | ||
) |
base | ANADIG_LDO_BBSM peripheral base address. |
config | Pointer to the structure pmu_static_aon_ana_ldo_config_t. |
void PMU_StaticAonAnaLdoDeinit | ( | ANADIG_LDO_BBSM_Type * | base | ) |
base | ANADIG_LDO_BBSM peripheral base address. |
void PMU_StaticGetAonDigLdoDefaultConfig | ( | pmu_static_aon_dig_config_t * | config | ) |
The default values are:
config | Pointer to the structure pmu_static_aon_dig_config_t. |
void PMU_StaticAonDigLdoInit | ( | ANADIG_LDO_BBSM_Type * | base, |
const pmu_static_aon_dig_config_t * | config | ||
) |
base | ANADIG_LDO_BBSM peripheral base address. |
config | Pointer to the structure pmu_static_aon_dig_config_t. |
void PMU_StaticAonDigLdoDeinit | ( | ANADIG_LDO_BBSM_Type * | base | ) |
base | ANADIG_LDO_BBSM peripheral base address. |
void PMU_GetBbsmDigLdoDefaultConfig | ( | pmu_bbsm_dig_config_t * | config | ) |
The default values are:
config | Pointer to pmu_bbsm_dig_config_t. |
void PMU_EnableLdoStandbyMode | ( | pmu_ldo_name_t | name, |
bool | enable | ||
) |
param name The name of the selected ldo. Please see the enumeration pmu_ldo_name_t for details. param enable Enable GPC standby mode or not.
void PMU_DisableBandgapSelfBiasAfterPowerUp | ( | void | ) |
This function should be invoked after powering up. This function will wait for the bandgap stable and disable the bandgap self bias. After powering up, it need to wait for the bandgap to get stable and then disable Bandgap Self bias for best noise performance.
void PMU_EnableBandgapSelfBiasBeforePowerDown | ( | void | ) |
This function will enable Bandgap self bias feature before powering down or there will be risk of Bandgap not starting properly.
void PMU_StaticBandgapInit | ( | const pmu_static_bandgap_config_t * | config | ) |
config | Pointer to the structure pmu_static_bandgap_config_t. |
void PMU_WellBiasInit | ( | ANADIG_PMU_Type * | base, |
const pmu_well_bias_config_t * | config | ||
) |
base | PMU peripheral base address. |
config | Pointer to the pmu_well_bias_config_t structure. |
void PMU_GetWellBiasDefaultConfig | ( | pmu_well_bias_config_t * | config | ) |
config | The pointer to the pmu_well_bias_config_t structure. |
void PMU_EnableFBB | ( | ANADIG_PMU_Type * | base, |
bool | enable | ||
) |
param base PMU peripheral base address. param enable Used to turn on/off FBB.
void PMU_EnableFBBStandbyMode | ( | ANADIG_PMU_Type * | base, |
bool | enable | ||
) |
param base PMU peripheral base address. param enable Enable GPC standby mode or not.