2434 lines
		
	
	
		
			97 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			2434 lines
		
	
	
		
			97 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  * Copyright 2022-2024 NXP
 | |
|  * All rights reserved.
 | |
|  *
 | |
|  * SPDX-License-Identifier: BSD-3-Clause
 | |
|  */
 | |
| 
 | |
| #ifndef FSL_SPC_H_
 | |
| #define FSL_SPC_H_
 | |
| #include "fsl_common.h"
 | |
| 
 | |
| /*!
 | |
|  * @addtogroup mcx_spc
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*******************************************************************************
 | |
|  * Definitions
 | |
|  ******************************************************************************/
 | |
| 
 | |
| /*! @name Driver version */
 | |
| /*! @{ */
 | |
| /*! @brief SPC driver version 2.4.2. */
 | |
| #define FSL_SPC_DRIVER_VERSION (MAKE_VERSION(2, 4, 2))
 | |
| /*! @} */
 | |
| 
 | |
| #define SPC_EVD_CFG_REG_EVDISO_SHIFT   0UL
 | |
| #define SPC_EVD_CFG_REG_EVDLPISO_SHIFT 8UL
 | |
| #define SPC_EVD_CFG_REG_EVDSTAT_SHIFT  16UL
 | |
| 
 | |
| #define SPC_EVD_CFG_REG_EVDISO(x)   ((uint32_t)(x) << SPC_EVD_CFG_REG_EVDISO_SHIFT)
 | |
| #define SPC_EVD_CFG_REG_EVDLPISO(x) ((uint32_t)(x) << SPC_EVD_CFG_REG_EVDLPISO_SHIFT)
 | |
| #define SPC_EVD_CFG_REG_EVDSTAT(x)  ((uint32_t)(x) << SPC_EVD_CFG_REG_EVDSTAT_SHIFT)
 | |
| 
 | |
| #if (defined(SPC_GLITCH_DETECT_SC_CNT_SELECT_MASK))
 | |
| #define VDD_CORE_GLITCH_DETECT_SC                             GLITCH_DETECT_SC
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_GLITCH_DETECT_FLAG_MASK SPC_GLITCH_DETECT_SC_GLITCH_DETECT_FLAG_MASK
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_GLITCH_DETECT_FLAG      SPC_GLITCH_DETECT_SC_GLITCH_DETECT_FLAG
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_LOCK_MASK               SPC_GLITCH_DETECT_SC_LOCK_MASK
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_CNT_SELECT_MASK         SPC_GLITCH_DETECT_SC_CNT_SELECT_MASK
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_CNT_SELECT              SPC_GLITCH_DETECT_SC_CNT_SELECT
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_RE_MASK                 SPC_GLITCH_DETECT_SC_RE_MASK
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_RE                      SPC_GLITCH_DETECT_SC_RE
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_TIMEOUT_MASK            SPC_GLITCH_DETECT_SC_TIMEOUT_MASK
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_TIMEOUT                 SPC_GLITCH_DETECT_SC_TIMEOUT
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_IE_MASK                 SPC_GLITCH_DETECT_SC_IE_MASK
 | |
| #define SPC_VDD_CORE_GLITCH_DETECT_SC_IE                      SPC_GLITCH_DETECT_SC_IE
 | |
| #endif
 | |
| 
 | |
| /*!
 | |
|  * @brief SPC status enumeration.
 | |
|  *
 | |
|  * @note Some device(such as MCXA family) do not equip DCDC or System LDO, please refer to the reference manual
 | |
|  * to check.
 | |
|  */
 | |
| enum
 | |
| {
 | |
|     kStatus_SPC_Busy = MAKE_STATUS(kStatusGroup_SPC, 0U), /*!< The SPC instance is busy executing any
 | |
|                                                                 type of power mode transition. */
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_DCDC) && FSL_FEATURE_MCX_SPC_HAS_DCDC)
 | |
|     kStatus_SPC_DCDCLowDriveStrengthIgnore = MAKE_STATUS(kStatusGroup_SPC, 1U), /*!< DCDC Low drive strength setting be
 | |
|                                                                                     ignored for LVD/HVD enabled. */
 | |
|     kStatus_SPC_DCDCPulseRefreshModeIgnore = MAKE_STATUS(kStatusGroup_SPC, 2U), /*!< DCDC Pulse Refresh Mode drive
 | |
|                                                                     strength setting be ignored for LVD/HVD enabled. */
 | |
| #endif                                                                          /* FSL_FEATURE_MCX_SPC_HAS_DCDC */
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SYS_LDO) && FSL_FEATURE_MCX_SPC_HAS_SYS_LDO)
 | |
|     kStatus_SPC_SYSLDOOverDriveVoltageFail = MAKE_STATUS(kStatusGroup_SPC, 3U), /*!< SYS LDO regulate to Over drive
 | |
|                                                                     voltage failed for SYS LDO HVD must be disabled. */
 | |
|     kStatus_SPC_SYSLDOLowDriveStrengthIgnore = MAKE_STATUS(kStatusGroup_SPC, 4U),  /*!< SYS LDO Low driver strength
 | |
|                                                                         setting be ignored for LDO LVD/HVD enabled. */
 | |
| #endif                                                                             /* FSL_FEATURE_MCX_SPC_HAS_SYS_LDO */
 | |
|     kStatus_SPC_CORELDOLowDriveStrengthIgnore = MAKE_STATUS(kStatusGroup_SPC, 5U), /*!< CORE LDO Low driver strength
 | |
|                                                                         setting be ignored for LDO LVD/HVD enabled. */
 | |
|     kStatus_SPC_CORELDOVoltageWrong   = MAKE_STATUS(kStatusGroup_SPC, 7U),         /*!< Core LDO voltage is wrong. */
 | |
|     kStatus_SPC_CORELDOVoltageSetFail = MAKE_STATUS(kStatusGroup_SPC, 8U),         /*!< Core LDO voltage set fail. */
 | |
|     kStatus_SPC_BandgapModeWrong      = MAKE_STATUS(kStatusGroup_SPC, 6U),         /*!< Selected Bandgap Mode wrong. */
 | |
| };
 | |
| 
 | |
| /*!
 | |
|  * @brief Voltage Detect Status Flags.
 | |
|  */
 | |
| enum _spc_voltage_detect_flags
 | |
| {
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD) && FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD)
 | |
|     kSPC_IOVDDHighVoltageDetectFlag = SPC_VD_STAT_IOVDD_HVDF_MASK,      /*!< IO VDD High-Voltage detect flag. */
 | |
|     kSPC_IOVDDLowVoltageDetectFlag  = SPC_VD_STAT_IOVDD_LVDF_MASK,      /*!< IO VDD Low-Voltage detect flag. */
 | |
| #endif                                                                  /* FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD */
 | |
|     kSPC_SystemVDDHighVoltageDetectFlag = SPC_VD_STAT_SYSVDD_HVDF_MASK, /*!< System VDD High-Voltage detect flag. */
 | |
|     kSPC_SystemVDDLowVoltageDetectFlag  = SPC_VD_STAT_SYSVDD_LVDF_MASK, /*!< System VDD Low-Voltage detect flag. */
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD) && FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD)
 | |
|     kSPC_CoreVDDHighVoltageDetectFlag = SPC_VD_STAT_COREVDD_HVDF_MASK,  /*!< Core VDD High-Voltage detect flag. */
 | |
| #endif                                                                  /* FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD */
 | |
|     kSPC_CoreVDDLowVoltageDetectFlag = SPC_VD_STAT_COREVDD_LVDF_MASK,   /*!< Core VDD Low-Voltage detect flag. */
 | |
| };
 | |
| 
 | |
| /*!
 | |
|  * @brief SPC power domain isolation status.
 | |
|  * @note Some devices(such as MCXA family) do not contain WAKE Power Domain, please refer to the reference manual to
 | |
|  * check.
 | |
|  */
 | |
| enum _spc_power_domains
 | |
| {
 | |
|     kSPC_MAINPowerDomainRetain = 1UL << 16U, /*!< Peripherals and IO pads retain in MAIN Power Domain. */
 | |
|     kSPC_WAKEPowerDomainRetain = 1UL << 17U, /*!< Peripherals and IO pads retain in WAKE Power Domain. */
 | |
| };
 | |
| 
 | |
| /*!
 | |
|  * @brief The enumeration of all analog module that can be controlled by SPC in active or low-power modes.
 | |
|  * @anchor spc_analog_module_control
 | |
|  */
 | |
| enum _spc_analog_module_control
 | |
| {
 | |
|     kSPC_controlVref       = 1UL << 0UL,  /*!< Enable/disable VREF in active or low-power modes. */
 | |
|     kSPC_controlUsb3vDet   = 1UL << 1UL,  /*!< Enable/disable USB3V_Det in active or low-power modes. */
 | |
|     kSPC_controlDac0       = 1UL << 4UL,  /*!< Enable/disable DAC0 in active or low-power modes. */
 | |
|     kSPC_controlDac1       = 1UL << 5UL,  /*!< Enable/disable DAC1 in active or low-power modes.  */
 | |
|     kSPC_controlDac2       = 1UL << 6UL,  /*!< Enable/disable DAC2 in active or low-power modes. */
 | |
|     kSPC_controlOpamp0     = 1UL << 8UL,  /*!< Enable/disable OPAMP0 in active or low-power modes. */
 | |
|     kSPC_controlOpamp1     = 1UL << 9UL,  /*!< Enable/disable OPAMP1 in active or low-power modes. */
 | |
|     kSPC_controlOpamp2     = 1UL << 10UL, /*!< Enable/disable OPAMP2 in active or low-power modes. */
 | |
|     kSPC_controlCmp0       = 1UL << 16UL, /*!< Enable/disable CMP0 in active or low-power modes. */
 | |
|     kSPC_controlCmp1       = 1UL << 17UL, /*!< Enable/disable CMP1 in active or low-power modes. */
 | |
|     kSPC_controlCmp2       = 1UL << 18UL, /*!< Enable/disable CMP2 in active or low-power modes. */
 | |
|     kSPC_controlCmp0Dac    = 1UL << 20UL, /*!< Enable/disable CMP0_DAC in active or low-power modes. */
 | |
|     kSPC_controlCmp1Dac    = 1UL << 21UL, /*!< Enable/disable CMP1_DAC in active or low-power modes. */
 | |
|     kSPC_controlCmp2Dac    = 1UL << 22UL, /*!< Enable/disable CMP2_DAC in active or low-power modes. */
 | |
|     kSPC_controlAllModules = 0x770773UL,  /*!< Enable/disable all modules in active or low-power modes. */
 | |
| };
 | |
| 
 | |
| /*!
 | |
|  * @brief The enumeration of spc power domain, the connected power domain is chip specific, please refer to chip's RM
 | |
|  * for details.
 | |
|  */
 | |
| typedef enum _spc_power_domain_id
 | |
| {
 | |
|     kSPC_PowerDomain0 = 0U, /*!< Power domain0, the connected power domain is chip specific. */
 | |
|     kSPC_PowerDomain1 = 1U, /*!< Power domain1, the connected power domain is chip specific. */
 | |
| } spc_power_domain_id_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief The enumeration of Power domain's low power mode.
 | |
|  */
 | |
| typedef enum _spc_power_domain_low_power_mode
 | |
| {
 | |
|     kSPC_SleepWithSYSClockRunning     = 0U, /*!< Power domain request SLEEP mode with SYS clock running. */
 | |
|     kSPC_DeepSleepWithSysClockOff     = 1U, /*!< Power domain request deep sleep mode with system clock off. */
 | |
|     kSPC_PowerDownWithSysClockOff     = 2U, /*!< Power domain request power down mode with system clock off. */
 | |
|     kSPC_DeepPowerDownWithSysClockOff = 4U, /*!< Power domain request deep power down mode with system clock off. */
 | |
| } spc_power_domain_low_power_mode_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief SPC low power request output pin polarity.
 | |
|  */
 | |
| typedef enum _spc_lowPower_request_pin_polarity
 | |
| {
 | |
|     kSPC_HighTruePolarity = 0x0U, /*!< Control the High Polarity of the Low Power Request Pin. */
 | |
|     kSPC_LowTruePolarity  = 0x1U, /*!< Control the Low Polarity of the Low Power Request Pin. */
 | |
| } spc_lowpower_request_pin_polarity_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief SPC low power request output override.
 | |
|  */
 | |
| typedef enum _spc_lowPower_request_output_override
 | |
| {
 | |
|     kSPC_LowPowerRequestNotForced  = 0x0U, /*!< Not Forced. */
 | |
|     kSPC_LowPowerRequestReserved   = 0x1U, /*!< Reserved. */
 | |
|     kSPC_LowPowerRequestForcedLow  = 0x2U, /*!< Forced Low (Ignore LowPower request output polarity setting.) */
 | |
|     kSPC_LowPowerRequestForcedHigh = 0x3U, /*!< Forced High (Ignore LowPower request output polarity setting.) */
 | |
| } spc_lowpower_request_output_override_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief SPC Bandgap mode enumeration in Active mode or Low Power mode.
 | |
|  */
 | |
| typedef enum _spc_bandgap_mode
 | |
| {
 | |
|     kSPC_BandgapDisabled              = 0x0U, /*!< Bandgap disabled. */
 | |
|     kSPC_BandgapEnabledBufferDisabled = 0x1U, /*!< Bandgap enabled with Buffer disabled. */
 | |
|     kSPC_BandgapEnabledBufferEnabled  = 0x2U, /*!< Bandgap enabled with Buffer enabled. */
 | |
|     kSPC_BandgapReserved              = 0x3U, /*!< Reserved. */
 | |
| } spc_bandgap_mode_t;
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_DCDC) && FSL_FEATURE_MCX_SPC_HAS_DCDC)
 | |
| /*!
 | |
|  * @brief DCDC regulator voltage level enumeration in Active mode or Low Power Mode.
 | |
|  *
 | |
|  * @note #kSPC_DCDC_RetentionVoltage not supported for all power modes.
 | |
|  */
 | |
| typedef enum _spc_dcdc_voltage_level
 | |
| {
 | |
|     kSPC_DCDC_RetentionVoltage = 0x0U, /*!< DCDC_CORE Regulator regulate to retention
 | |
|                                            Voltage(Only supportedin low power modes) */
 | |
|     kSPC_DCDC_MidVoltage       = 0x1U, /*!< DCDC_CORE Regulator regulate to Mid Voltage(1.0V). */
 | |
|     kSPC_DCDC_NormalVoltage    = 0x2U, /*!< DCDC_CORE Regulator regulate to Normal Voltage(1.1V). */
 | |
|     kSPC_DCDC_OverdriveVoltage = 0x3U, /*!< DCDC_CORE Regulator regulate to Safe-Mode Voltage(1.2V). */
 | |
| } spc_dcdc_voltage_level_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief DCDC regulator Drive Strength enumeration in Active mode or Low Power Mode.
 | |
|  *
 | |
|  * @note Different drive strength differ in these DCDC characteristics:
 | |
|  *              Maximum load current
 | |
|  *              Quiescent current
 | |
|  *              Transient response.
 | |
|  */
 | |
| typedef enum _spc_dcdc_drive_strength
 | |
| {
 | |
|     kSPC_DCDC_PulseRefreshMode = 0x0U,    /*!< DCDC_CORE Regulator Drive Strength set to Pulse Refresh Mode,
 | |
|                                            * This enum member is only useful for Low Power Mode config, please
 | |
|                                            * note that pulse refresh mode is invalid in SLEEP mode.
 | |
|                                            */
 | |
|     kSPC_DCDC_LowDriveStrength    = 0x1U, /*!< DCDC_CORE regulator Drive Strength set to low. */
 | |
|     kSPC_DCDC_NormalDriveStrength = 0x2U, /*!< DCDC_CORE regulator Drive Strength set to Normal. */
 | |
| } spc_dcdc_drive_strength_t;
 | |
| #endif                                    /* FSL_FEATURE_MCX_SPC_HAS_DCDC */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SYS_LDO) && FSL_FEATURE_MCX_SPC_HAS_SYS_LDO)
 | |
| /*!
 | |
|  * @brief SYS LDO regulator voltage level enumeration in Active mode.
 | |
|  */
 | |
| typedef enum _spc_sys_ldo_voltage_level
 | |
| {
 | |
|     kSPC_SysLDO_NormalVoltage    = 0x0U, /*!< SYS LDO VDD Regulator regulate to Normal Voltage(1.8V). */
 | |
|     kSPC_SysLDO_OverDriveVoltage = 0x1U, /*!< SYS LDO VDD Regulator regulate to Over Drive Voltage(2.5V). */
 | |
| } spc_sys_ldo_voltage_level_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief SYS LDO regulator Drive Strength enumeration in Active mode or Low Power mode.
 | |
|  */
 | |
| typedef enum _spc_sys_ldo_drive_strength
 | |
| {
 | |
|     kSPC_SysLDO_LowDriveStrength    = 0x0U, /*!< SYS LDO VDD regulator Drive Strength set to low. */
 | |
|     kSPC_SysLDO_NormalDriveStrength = 0x1U, /*!< SYS LDO VDD regulator Drive Strength set to Normal. */
 | |
| } spc_sys_ldo_drive_strength_t;
 | |
| #endif                                      /* FSL_FEATURE_MCX_SPC_HAS_SYS_LDO */
 | |
| 
 | |
| /*!
 | |
|  * @brief Core LDO regulator voltage level enumeration in Active mode or Low Power mode.
 | |
|  */
 | |
| typedef enum _spc_core_ldo_voltage_level
 | |
| {
 | |
|     kSPC_CoreLDO_UnderDriveVoltage = 0x0U, /*!< @deprecated, to align with description of latest RM, please use
 | |
|                                             #kSPC_Core_LDO_RetentionVoltage as instead. */
 | |
|     kSPC_Core_LDO_RetentionVoltage = 0x0U, /*!< Core LDO VDD regulator regulate to retention voltage, please note that
 | |
|                                            only useful in low power modes and not all devices support this options
 | |
|                                            please refer to devices' RM for details. */
 | |
|     kSPC_CoreLDO_MidDriveVoltage  = 0x1U,  /*!< Core LDO VDD regulator regulate to Mid Drive Voltage. */
 | |
|     kSPC_CoreLDO_NormalVoltage    = 0x2U,  /*!< Core LDO VDD regulator regulate to Normal Voltage. */
 | |
|     kSPC_CoreLDO_OverDriveVoltage = 0x3U,  /*!< Core LDO VDD regulator regulate to overdrive Voltage. */
 | |
| } spc_core_ldo_voltage_level_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief CORE LDO VDD regulator Drive Strength enumeration in Low Power mode.
 | |
|  */
 | |
| typedef enum _spc_core_ldo_drive_strength
 | |
| {
 | |
|     kSPC_CoreLDO_LowDriveStrength    = 0x0U, /*!< Core LDO VDD regulator Drive Strength set to low. */
 | |
|     kSPC_CoreLDO_NormalDriveStrength = 0x1U, /*!< Core LDO VDD regulator Drive Strength set to Normal. */
 | |
| } spc_core_ldo_drive_strength_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief IO VDD Low-Voltage Level Select.
 | |
|  */
 | |
| typedef enum _spc_low_voltage_level_select
 | |
| {
 | |
|     kSPC_LowVoltageNormalLevel = 0x0U, /*!< @deprecated, please use kSPC_LowVoltageHighRange as instead. */
 | |
|     kSPC_LowVoltageSafeLevel   = 0x1U, /*!< @deprecated, please use kSPC_LowVoltageLowRange as instead. */
 | |
| 
 | |
|     kSPC_LowVoltageHighRange = 0x0U,   /*!< High range LVD threshold. */
 | |
|     kSPC_LowVoltageLowRange  = 0x1U,  /*!< Low range LVD threshold. */
 | |
| } spc_low_voltage_level_select_t;
 | |
| 
 | |
| #if !(defined(FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT) && FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT)
 | |
| /*!
 | |
|  * @brief Used to select output of 4-bit ripple counter is used to monitor a glitch on VDD core.
 | |
|  */
 | |
| typedef enum _spc_vdd_core_glitch_ripple_counter_select
 | |
| {
 | |
|     kSPC_selectBit0Of4bitRippleCounter = 0x0U, /*!< Select bit-0 of 4-bit Ripple Counter
 | |
|                                                     to detect glitch on VDD Core. */
 | |
|     kSPC_selectBit1Of4bitRippleCounter = 0x1U, /*!< Select bit-1 of 4-bit Ripple Counter
 | |
|                                                     to detect glitch on VDD Core. */
 | |
|     kSPC_selectBit2Of4bitRippleCounter = 0x2U, /*!< Select bit-2 of 4-bit Ripple Counter
 | |
|                                                     to detect glitch on VDD Core. */
 | |
|     kSPC_selectBit3Of4bitRippleCounter = 0x3U, /*!< Select bit-3 of 4-bit Ripple Counter
 | |
|                                                     to detect glitch on VDD Core. */
 | |
| } spc_vdd_core_glitch_ripple_counter_select_t;
 | |
| #endif
 | |
| 
 | |
| /*!
 | |
|  * @brief The list of the operating voltage for the SRAM's read/write timing margin.
 | |
|  */
 | |
| typedef enum _spc_sram_operate_voltage
 | |
| {
 | |
|     kSPC_sramOperateAt1P0V = 0x1U, /*!< SRAM configured for 1.0V operation. */
 | |
|     kSPC_sramOperateAt1P1V = 0x2U, /*!< SRAM configured for 1.1V operation. */
 | |
|     kSPC_sramOperateAt1P2V = 0x3U, /*!< SRAM configured for 1.2V operation. */
 | |
| } spc_sram_operate_voltage_t;
 | |
| 
 | |
| #if !(defined(FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT) && FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT)
 | |
| /*!
 | |
|  * @brief The configuration of VDD Core glitch detector.
 | |
|  */
 | |
| typedef struct _spc_vdd_core_glitch_detector_config
 | |
| {
 | |
|     spc_vdd_core_glitch_ripple_counter_select_t rippleCounterSelect; /*!< Used to set ripple counter. */
 | |
|     uint8_t resetTimeoutValue; /*!< The timeout value used to reset glitch detect/compare logic after an initial
 | |
|                               glitch is detected. */
 | |
|     bool enableReset;          /*!< Used to enable/disable POR/LVD reset that caused by CORE VDD glitch detect error. */
 | |
|     bool enableInterrupt;      /*!< Used to enable/disable hardware interrupt if CORE VDD glitch detect error. */
 | |
| } spc_vdd_core_glitch_detector_config_t;
 | |
| #endif
 | |
| 
 | |
| typedef struct _spc_sram_voltage_config
 | |
| {
 | |
|     spc_sram_operate_voltage_t operateVoltage; /*!< Specifies the operating voltage for the SRAM's
 | |
|                                                      read/write timing margin.  */
 | |
|     bool requestVoltageUpdate;                 /*!< Used to control whether request an SRAM trim value change. */
 | |
| } spc_sram_voltage_config_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief Low Power Request output pin configuration.
 | |
|  */
 | |
| typedef struct _spc_lowpower_request_config
 | |
| {
 | |
|     bool enable;                                     /*!< Low Power Request Output enable. */
 | |
|     spc_lowpower_request_pin_polarity_t polarity;    /*!< Low Power Request Output pin polarity select. */
 | |
|     spc_lowpower_request_output_override_t override; /*!< Low Power Request Output Override. */
 | |
| } spc_lowpower_request_config_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief Core LDO regulator options in Active mode.
 | |
|  */
 | |
| typedef struct _spc_active_mode_core_ldo_option
 | |
| {
 | |
|     spc_core_ldo_voltage_level_t CoreLDOVoltage; /*!< Core LDO Regulator Voltage Level selection in Active mode. */
 | |
| #if defined(FSL_FEATURE_SPC_HAS_CORELDO_VDD_DS) && FSL_FEATURE_SPC_HAS_CORELDO_VDD_DS
 | |
|     spc_core_ldo_drive_strength_t CoreLDODriveStrength; /*!< Core LDO Regulator Drive Strength
 | |
|                                                             selection in Active mode */
 | |
| #endif                                                  /* FSL_FEATURE_SPC_HAS_CORELDO_VDD_DS */
 | |
| } spc_active_mode_core_ldo_option_t;
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SYS_LDO) && FSL_FEATURE_MCX_SPC_HAS_SYS_LDO)
 | |
| /*!
 | |
|  * @brief System LDO regulator options in Active mode.
 | |
|  */
 | |
| typedef struct _spc_active_mode_sys_ldo_option
 | |
| {
 | |
|     spc_sys_ldo_voltage_level_t SysLDOVoltage; /*!< System LDO Regulator Voltage Level selection in Active mode. */
 | |
|     spc_sys_ldo_drive_strength_t SysLDODriveStrength; /*!< System LDO Regulator Drive Strength
 | |
|                                                             selection in Active mode. */
 | |
| } spc_active_mode_sys_ldo_option_t;
 | |
| #endif                                                /* FSL_FEATURE_MCX_SPC_HAS_SYS_LDO */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_DCDC) && FSL_FEATURE_MCX_SPC_HAS_DCDC)
 | |
| /*!
 | |
|  * @brief DCDC regulator options in Active mode.
 | |
|  */
 | |
| typedef struct _spc_active_mode_dcdc_option
 | |
| {
 | |
|     spc_dcdc_voltage_level_t DCDCVoltage;        /*!< DCDC Regulator Voltage Level selection in Active mode. */
 | |
|     spc_dcdc_drive_strength_t DCDCDriveStrength; /*!< DCDC_CORE Regulator Drive Strength selection in Active mode. */
 | |
| } spc_active_mode_dcdc_option_t;
 | |
| #endif                                           /* FSL_FEATURE_MCX_SPC_HAS_DCDC */
 | |
| 
 | |
| /*!
 | |
|  * @brief Core LDO regulator options in Low Power mode.
 | |
|  */
 | |
| typedef struct _spc_lowpower_mode_core_ldo_option
 | |
| {
 | |
|     spc_core_ldo_voltage_level_t CoreLDOVoltage; /*!< Core LDO Regulator Voltage Level selection in Low Power mode. */
 | |
|     spc_core_ldo_drive_strength_t CoreLDODriveStrength; /*!< Core LDO Regulator Drive Strength
 | |
|                                                             selection in Low Power mode */
 | |
| } spc_lowpower_mode_core_ldo_option_t;
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SYS_LDO) && FSL_FEATURE_MCX_SPC_HAS_SYS_LDO)
 | |
| /*!
 | |
|  * @brief System LDO regulator options in Low Power mode.
 | |
|  */
 | |
| typedef struct _spc_lowpower_mode_sys_ldo_option
 | |
| {
 | |
|     spc_sys_ldo_drive_strength_t SysLDODriveStrength; /*!< System LDO Regulator Drive Strength
 | |
|                                                             selection in Low Power mode. */
 | |
| } spc_lowpower_mode_sys_ldo_option_t;
 | |
| #endif                                                /* FSL_FEATURE_MCX_SPC_HAS_SYS_LDO */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_DCDC) && FSL_FEATURE_MCX_SPC_HAS_DCDC)
 | |
| /*!
 | |
|  * @brief DCDC regulator options in Low Power mode.
 | |
|  */
 | |
| typedef struct _spc_lowpower_mode_dcdc_option
 | |
| {
 | |
|     spc_dcdc_voltage_level_t DCDCVoltage;        /*!< DCDC Regulator Voltage Level selection in Low Power mode. */
 | |
|     spc_dcdc_drive_strength_t DCDCDriveStrength; /*!< DCDC_CORE Regulator Drive Strength selection in Low Power mode. */
 | |
| } spc_lowpower_mode_dcdc_option_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief DCDC Burst configuration.
 | |
|  * @deprecated Do not recommend to use this structure.
 | |
|  */
 | |
| typedef struct _spc_dcdc_burst_config
 | |
| {
 | |
|     bool sofwareBurstRequest;  /*!< Enable/Disable DCDC Software Burst Request. */
 | |
|     bool externalBurstRequest; /*!< Enable/Disable DCDC External Burst Request. */
 | |
|     bool stabilizeBurstFreq;   /*!< Enable/Disable DCDC frequency stabilization. */
 | |
|     uint8_t freq;              /*!< The frequency of the current burst.  */
 | |
| } spc_dcdc_burst_config_t;
 | |
| #endif                         /* FSL_FEATURE_MCX_SPC_HAS_DCDC */
 | |
| 
 | |
| /*!
 | |
|  * @brief CORE/SYS/IO VDD Voltage Detect options.
 | |
|  */
 | |
| typedef struct _spc_voltage_detect_option
 | |
| {
 | |
|     bool HVDInterruptEnable; /*!< CORE/SYS/IO VDD High Voltage Detect interrupt enable. */
 | |
|     bool HVDResetEnable;     /*!< CORE/SYS/IO VDD High Voltage Detect reset enable. */
 | |
|     bool LVDInterruptEnable; /*!< CORE/SYS/IO VDD Low Voltage Detect interrupt enable. */
 | |
|     bool LVDResetEnable;     /*!< CORE/SYS/IO VDD Low Voltage Detect reset enable. */
 | |
| } spc_voltage_detect_option_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief Core Voltage Detect configuration.
 | |
|  */
 | |
| typedef struct _spc_core_voltage_detect_config
 | |
| {
 | |
|     spc_voltage_detect_option_t option; /*!< Core VDD Voltage Detect option. */
 | |
| } spc_core_voltage_detect_config_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief System Voltage Detect Configuration.
 | |
|  */
 | |
| typedef struct _spc_system_voltage_detect_config
 | |
| {
 | |
|     spc_voltage_detect_option_t option;   /*!< System VDD Voltage Detect option. */
 | |
|     spc_low_voltage_level_select_t level; /*!< @deprecated, reserved for all devices, will removed in next release. */
 | |
| } spc_system_voltage_detect_config_t;
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD) && FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD)
 | |
| /*!
 | |
|  * @brief IO Voltage Detect Configuration.
 | |
|  */
 | |
| typedef struct _spc_io_voltage_detect_config
 | |
| {
 | |
|     spc_voltage_detect_option_t option;   /*!< IO VDD Voltage Detect option. */
 | |
|     spc_low_voltage_level_select_t level; /*!< IO VDD Low-voltage level selection. */
 | |
| } spc_io_voltage_detect_config_t;
 | |
| #endif                                    /* FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD */
 | |
| 
 | |
| /*!
 | |
|  * @brief Active mode configuration.
 | |
|  */
 | |
| typedef struct _spc_active_mode_regulators_config
 | |
| {
 | |
|     spc_bandgap_mode_t bandgapMode; /*!< Specify bandgap mode in active mode. */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT) && FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT)
 | |
|     bool lpBuff; /*!< Enable/disable CMP bandgap buffer. */
 | |
| #endif           /* FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_DCDC) && FSL_FEATURE_MCX_SPC_HAS_DCDC)
 | |
|     spc_active_mode_dcdc_option_t DCDCOption; /*!< Specify DCDC configurations in active mode. */
 | |
| #endif                                        /* FSL_FEATURE_MCX_SPC_HAS_DCDC */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SYS_LDO) && FSL_FEATURE_MCX_SPC_HAS_SYS_LDO)
 | |
|     spc_active_mode_sys_ldo_option_t SysLDOOption;   /*!< Specify System LDO configurations in active mode. */
 | |
| #endif                                               /* FSL_FEATURE_MCX_SPC_HAS_SYS_LDO */
 | |
| 
 | |
|     spc_active_mode_core_ldo_option_t CoreLDOOption; /*!< Specify Core LDO configurations in active mode. */
 | |
| } spc_active_mode_regulators_config_t;
 | |
| 
 | |
| /*!
 | |
|  * @brief Low Power Mode configuration.
 | |
|  */
 | |
| typedef struct _spc_lowpower_mode_regulators_config
 | |
| {
 | |
|     bool lpIREF;                    /*!< Enable/disable low power IREF in low power modes. */
 | |
|     spc_bandgap_mode_t bandgapMode; /*!< Specify bandgap mode in low power modes. */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT) && FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT)
 | |
|     bool lpBuff; /*!< Enable/disable CMP bandgap buffer in low power modes. */
 | |
| #endif           /* FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_COREVDD_IVS_EN_BIT) && FSL_FEATURE_MCX_SPC_HAS_COREVDD_IVS_EN_BIT)
 | |
|     bool CoreIVS; /*!< Enable/disable CORE VDD internal voltage scaling. */
 | |
| #endif            /* FSL_FEATURE_MCX_SPC_HAS_COREVDD_IVS_EN_BIT */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_DCDC) && FSL_FEATURE_MCX_SPC_HAS_DCDC)
 | |
|     spc_lowpower_mode_dcdc_option_t DCDCOption; /*!< Specify DCDC configurations in low power modes. */
 | |
| #endif                                          /* FSL_FEATURE_MCX_SPC_HAS_DCDC */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SYS_LDO) && FSL_FEATURE_MCX_SPC_HAS_SYS_LDO)
 | |
|     spc_lowpower_mode_sys_ldo_option_t SysLDOOption;   /*!< Specify system LDO configurations in low power modes. */
 | |
| #endif                                                 /* FSL_FEATURE_MCX_SPC_HAS_SYS_LDO */
 | |
| 
 | |
|     spc_lowpower_mode_core_ldo_option_t CoreLDOOption; /*!< Specify core LDO configurations in low power modes. */
 | |
| } spc_lowpower_mode_regulators_config_t;
 | |
| 
 | |
| /*******************************************************************************
 | |
|  * API
 | |
|  ******************************************************************************/
 | |
| #if defined(__cplusplus)
 | |
| extern "C" {
 | |
| #endif /* __cplusplus */
 | |
| 
 | |
| /*!
 | |
|  * @name SPC Status
 | |
|  * @{
 | |
|  */
 | |
| /*!
 | |
|  * @brief Gets Isolation status for each power domains.
 | |
|  *
 | |
|  * This function gets the status which indicates whether certain
 | |
|  * peripheral and the IO pads are in a latched state as a result
 | |
|  * of having been in POWERDOWN mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return Current isolation status for each power domains. See @ref _spc_power_domains for details.
 | |
|  */
 | |
| uint8_t SPC_GetPeriphIOIsolationStatus(SPC_Type *base);
 | |
| 
 | |
| /*!
 | |
|  * @brief Clears peripherals and I/O pads isolation flags for each power domains.
 | |
|  *
 | |
|  * This function clears peripherals and I/O pads isolation flags for each power domains.
 | |
|  * After recovering from the POWERDOWN mode, user must invoke this function to release the
 | |
|  * I/O pads and certain peripherals to their normal run mode state. Before invoking this
 | |
|  * function, user must restore chip configuration in particular pin configuration for enabled
 | |
|  * WUU wakeup pins.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_ClearPeriphIOIsolationFlag(SPC_Type *base)
 | |
| {
 | |
|     base->SC |= SPC_SC_ISO_CLR_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets SPC busy status flag.
 | |
|  *
 | |
|  * This function gets SPC busy status flag. When SPC executing any type of power mode
 | |
|  * transition in ACTIVE mode or any of the SOC low power mode, the SPC busy status flag is set
 | |
|  * and this function returns true. When changing CORE LDO voltage level and DCDC voltage level
 | |
|  * in ACTIVE mode, the SPC busy status flag is set and this function return true.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return Ack busy flag.
 | |
|  *          true    -   SPC is busy.
 | |
|  *          false   -   SPC is not busy.
 | |
|  */
 | |
| static inline bool SPC_GetBusyStatusFlag(SPC_Type *base)
 | |
| {
 | |
|     return ((base->SC & SPC_SC_BUSY_MASK) != 0UL);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Checks system low power request.
 | |
|  *
 | |
|  * @note Only when all power domains request low power mode entry, the result of this function is true. That means when
 | |
|  * all power domains request low power mode entry, the SPC regulators will be controlled by LP_CFG register.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return The system low power request check result.
 | |
|  *       - \b true All power domains have requested low power mode and SPC has entered a low power state and power mode
 | |
|  *                 configuration are based on the LP_CFG configuration register.
 | |
|  *       - \b false SPC in active mode and ACTIVE_CFG register control system power supply.
 | |
|  */
 | |
| static inline bool SPC_CheckLowPowerReqest(SPC_Type *base)
 | |
| {
 | |
|     return ((base->SC & SPC_SC_SPC_LP_REQ_MASK) == SPC_SC_SPC_LP_REQ_MASK);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Clears system low power request, set SPC in active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_ClearLowPowerRequest(SPC_Type *base)
 | |
| {
 | |
|     base->SC |= SPC_SC_SPC_LP_REQ_MASK;
 | |
| }
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SWITCH_STATE_BIT) && FSL_FEATURE_MCX_SPC_HAS_SWITCH_STATE_BIT)
 | |
| /*!
 | |
|  * @brief Checks whether the power switch is on.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  *
 | |
|  * @retval true The power switch is on.
 | |
|  * @retval false The power switch is off.
 | |
|  */
 | |
| static inline bool SPC_CheckSwitchState(SPC_Type *base)
 | |
| {
 | |
|     return ((base->SC & SPC_SC_SWITCH_STATE_MASK) != 0UL);
 | |
| }
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_SWITCH_STATE_BIT */
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets selected power domain's requested low power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param powerDomainId Power Domain Id, please refer to @ref spc_power_domain_id_t.
 | |
|  *
 | |
|  * @return The selected power domain's requested low power mode, please refer to @ref spc_power_domain_low_power_mode_t.
 | |
|  */
 | |
| spc_power_domain_low_power_mode_t SPC_GetPowerDomainLowPowerMode(SPC_Type *base, spc_power_domain_id_t powerDomainId);
 | |
| 
 | |
| /*!
 | |
|  * @brief Checks power domain's low power request.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param powerDomainId Power Domain Id, please refer to @ref spc_power_domain_id_t.
 | |
|  * @return The result of power domain's low power request.
 | |
|  *            - \b true The selected power domain requests low power mode entry.
 | |
|  *            - \b false The selected power domain does not request low power mode entry.
 | |
|  */
 | |
| static inline bool SPC_CheckPowerDomainLowPowerRequest(SPC_Type *base, spc_power_domain_id_t powerDomainId)
 | |
| {
 | |
|     assert((uint8_t)powerDomainId < SPC_PD_STATUS_COUNT);
 | |
|     return ((base->PD_STATUS[(uint8_t)powerDomainId] & SPC_PD_STATUS_PWR_REQ_STATUS_MASK) ==
 | |
|             SPC_PD_STATUS_PWR_REQ_STATUS_MASK);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Clears selected power domain's low power request flag.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param powerDomainId Power Domain Id, please refer to @ref spc_power_domain_id_t.
 | |
|  */
 | |
| static inline void SPC_ClearPowerDomainLowPowerRequestFlag(SPC_Type *base, spc_power_domain_id_t powerDomainId)
 | |
| {
 | |
|     assert((uint8_t)powerDomainId < SPC_PD_STATUS_COUNT);
 | |
|     base->PD_STATUS[(uint8_t)powerDomainId] |= SPC_PD_STATUS_PD_LP_REQ_MASK;
 | |
| }
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SRAMRETLDO_REG) && FSL_FEATURE_MCX_SPC_HAS_SRAMRETLDO_REG)
 | |
| /*!
 | |
|  * @name SRAM Retention LDO Control APIs
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*!
 | |
|  * @brief Trims SRAM retention regulator reference voltage, trim step is 12 mV, range is around 0.48V to 0.85V.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param trimValue Reference voltage trim value.
 | |
|  */
 | |
| static inline void SPC_TrimSRAMLdoRefVoltage(SPC_Type *base, uint8_t trimValue)
 | |
| {
 | |
|     base->SRAMRETLDO_REFTRIM =
 | |
|         ((base->SRAMRETLDO_REFTRIM & ~SPC_SRAMRETLDO_REFTRIM_REFTRIM_MASK) | SPC_SRAMRETLDO_REFTRIM_REFTRIM(trimValue));
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/disables SRAM retention LDO.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Used to enable/disable SRAM LDO :
 | |
|  *          - \b true Enable SRAM LDO;
 | |
|  *          - \b false Disable SRAM LDO.
 | |
|  */
 | |
| static inline void SPC_EnableSRAMLdo(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->SRAMRETLDO_CNTRL |= SPC_SRAMRETLDO_CNTRL_SRAMLDO_ON_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->SRAMRETLDO_CNTRL &= ~SPC_SRAMRETLDO_CNTRL_SRAMLDO_ON_MASK;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief
 | |
|  *
 | |
|  * @todo Need to check.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param mask The OR'ed value of SRAM Array.
 | |
|  */
 | |
| static inline void SPC_RetainSRAMArray(SPC_Type *base, uint8_t mask)
 | |
| {
 | |
|     base->SRAMRETLDO_CNTRL |= SPC_SRAMRETLDO_CNTRL_SRAM_RET_EN(mask);
 | |
| }
 | |
| 
 | |
| /*! @} */
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_SRAMRETLDO_REG */
 | |
| 
 | |
| /*!
 | |
|  * @name Low Power Request configuration
 | |
|  * @{
 | |
|  */
 | |
| /*!
 | |
|  * @brief Configs Low power request output pin.
 | |
|  *
 | |
|  * This function config the low power request output pin
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param config Pointer the @ref spc_lowpower_request_config_t structure.
 | |
|  */
 | |
| void SPC_SetLowPowerRequestConfig(SPC_Type *base, const spc_lowpower_request_config_t *config);
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_CFG_REG) && FSL_FEATURE_MCX_SPC_HAS_CFG_REG)
 | |
| /*!
 | |
|  * @name Integrated Power Switch Control APIs
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/disables the integrated power switch manually.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Used to enable/disable the integrated power switch:
 | |
|  *             - \b true Enable the integrated power switch;
 | |
|  *             - \b false Disable the integrated power switch.
 | |
|  */
 | |
| static inline void SPC_EnableIntegratedPowerSwitchManually(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->CFG |= (SPC_CFG_INTG_PWSWTCH_SLEEP_ACTIVE_EN_MASK | SPC_CFG_INTG_PWSWTCH_WKUP_ACTIVE_EN_MASK);
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->CFG &= ~(SPC_CFG_INTG_PWSWTCH_SLEEP_ACTIVE_EN_MASK | SPC_CFG_INTG_PWSWTCH_WKUP_ACTIVE_EN_MASK);
 | |
|     }
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/disables the integrated power switch automatically.
 | |
|  *
 | |
|  * To gate the integrated power switch when chip enter low power modes, and ungate the switch after wake-up from low
 | |
|  * power modes:
 | |
|  * @code
 | |
|  *   SPC_EnableIntegratedPowerSwitchAutomatically(SPC, true, true);
 | |
|  * @endcode
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param sleepGate Enable the integrated power switch when chip enter low power modes:
 | |
|  *          - \b true SPC asserts an output pin at low-power entry to power-gate the switch;
 | |
|  *          - \b false SPC does not assert an output pin at low-power entry to power-gate the switch.
 | |
|  * @param wakeupUngate Enables the switch after wake-up from low power modes:
 | |
|  *          - \b true SPC asserts an output pin at low-power exit to power-ungate the switch;
 | |
|  *          - \b false SPC does not assert an output pin at low-power exit to power-ungate the switch.
 | |
|  */
 | |
| static inline void SPC_EnableIntegratedPowerSwitchAutomatically(SPC_Type *base, bool sleepGate, bool wakeupUngate)
 | |
| {
 | |
|     uint32_t tmp32 = ((base->CFG) & ~(SPC_CFG_INTG_PWSWTCH_SLEEP_EN_MASK | SPC_CFG_INTG_PWSWTCH_WKUP_EN_MASK));
 | |
| 
 | |
|     tmp32 |= SPC_CFG_INTG_PWSWTCH_SLEEP_EN(sleepGate) | SPC_CFG_INTG_PWSWTCH_WKUP_EN(wakeupUngate);
 | |
| 
 | |
|     base->CFG = tmp32;
 | |
| }
 | |
| 
 | |
| /*! @} */
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_CFG_REG */
 | |
| 
 | |
| #if !(defined(FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT) && FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT)
 | |
| /*!
 | |
|  * @name VDD Core Glitch Detector Control APIs
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*!
 | |
|  * @brief Configures VDD Core Glitch detector, including ripple counter selection, timeout value and so on.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param config Pointer to the structure in type of @ref spc_vdd_core_glitch_detector_config_t.
 | |
|  */
 | |
| void SPC_ConfigVddCoreGlitchDetector(SPC_Type *base, const spc_vdd_core_glitch_detector_config_t *config);
 | |
| 
 | |
| /*!
 | |
|  * @brief Checks selected 4-bit glitch ripple counter's output.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param rippleCounter The ripple counter to check, please refer to @ref spc_vdd_core_glitch_ripple_counter_select_t.
 | |
|  *
 | |
|  * @retval true The selected ripple counter output is 1, will generate interrupt or reset based on settings.
 | |
|  * @retval false The selected ripple counter output is 0.
 | |
|  */
 | |
| 
 | |
| static inline bool SPC_CheckGlitchRippleCounterOutput(SPC_Type *base,
 | |
|                                                       spc_vdd_core_glitch_ripple_counter_select_t rippleCounter)
 | |
| {
 | |
|     return ((base->VDD_CORE_GLITCH_DETECT_SC & SPC_VDD_CORE_GLITCH_DETECT_SC_GLITCH_DETECT_FLAG_MASK) ==
 | |
|             SPC_VDD_CORE_GLITCH_DETECT_SC_GLITCH_DETECT_FLAG(1UL << (uint32_t)(rippleCounter)));
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Clears output of selected glitch ripple counter.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param rippleCounter The ripple counter to check, please refer to @ref spc_vdd_core_glitch_ripple_counter_select_t.
 | |
|  */
 | |
| static inline void SPC_ClearGlitchRippleCounterOutput(SPC_Type *base,
 | |
|                                                       spc_vdd_core_glitch_ripple_counter_select_t rippleCounter)
 | |
| {
 | |
|     base->VDD_CORE_GLITCH_DETECT_SC |=
 | |
|         SPC_VDD_CORE_GLITCH_DETECT_SC_GLITCH_DETECT_FLAG(1UL << (uint32_t)(rippleCounter));
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief After invoking this function, writes to SPC_VDD_CORE_GLITCH_DETECT_SC[RE] register are ignored.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_LockVddCoreVoltageGlitchDetectResetControl(SPC_Type *base)
 | |
| {
 | |
|     base->VDD_CORE_GLITCH_DETECT_SC |= SPC_VDD_CORE_GLITCH_DETECT_SC_LOCK_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief After invoking this function, writes to SPC_VDD_CORE_GLITCH_DETECT_SC[RE] register are allowed.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_UnlockVddCoreVoltageGlitchDetectResetControl(SPC_Type *base)
 | |
| {
 | |
|     base->VDD_CORE_GLITCH_DETECT_SC &= ~SPC_VDD_CORE_GLITCH_DETECT_SC_LOCK_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Checks if SPC_VDD_CORE_GLITCH_DETECT_SC[RE] register is writable.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  *
 | |
|  * @retval true SPC_VDD_CORE_GLITCH_DETECT_SC[RE] register is writable.
 | |
|  * @retval false SPC_VDD_CORE_GLITCH_DETECT_SC[RE] register is not writable.
 | |
|  */
 | |
| static inline bool SPC_CheckVddCoreVoltageGlitchResetControlState(SPC_Type *base)
 | |
| {
 | |
|     return ((base->VDD_CORE_GLITCH_DETECT_SC & SPC_VDD_CORE_GLITCH_DETECT_SC_LOCK_MASK) != 0UL);
 | |
| }
 | |
| 
 | |
| /*! @} */
 | |
| #endif
 | |
| 
 | |
| /*!
 | |
|  * @name SRAM Control APIs
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*!
 | |
|  * @brief Set SRAM operate voltage.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param config The pointer to @ref spc_sram_voltage_config_t, specifies the configuration of sram voltage.
 | |
|  */
 | |
| void SPC_SetSRAMOperateVoltage(SPC_Type *base, const spc_sram_voltage_config_t *config);
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| /*!
 | |
|  * @name Active Mode configuration
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets the Bandgap mode in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return Bandgap mode in the type of @ref spc_bandgap_mode_t enumeration.
 | |
|  */
 | |
| static inline spc_bandgap_mode_t SPC_GetActiveModeBandgapMode(SPC_Type *base)
 | |
| {
 | |
|     return (spc_bandgap_mode_t)(uint32_t)((base->ACTIVE_CFG & SPC_ACTIVE_CFG_BGMODE_MASK) >>
 | |
|                                           SPC_ACTIVE_CFG_BGMODE_SHIFT);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets all voltage detectors status in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return All voltage detectors status in Active mode.
 | |
|  */
 | |
| static inline uint32_t SPC_GetActiveModeVoltageDetectStatus(SPC_Type *base)
 | |
| {
 | |
|     uint32_t state;
 | |
|     state = base->ACTIVE_CFG &
 | |
|             (
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD) && FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD)
 | |
|                 SPC_ACTIVE_CFG_IO_HVDE_MASK | SPC_ACTIVE_CFG_IO_LVDE_MASK |
 | |
| 
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD */
 | |
|                 SPC_ACTIVE_CFG_SYS_HVDE_MASK | SPC_ACTIVE_CFG_SYS_LVDE_MASK | SPC_ACTIVE_CFG_CORE_LVDE_MASK
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD) && FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD)
 | |
|                 | SPC_ACTIVE_CFG_CORE_HVDE_MASK
 | |
| 
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD */
 | |
|             );
 | |
|     return state;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs Bandgap mode in Active mode.
 | |
|  *
 | |
|  * @note To disable bandgap in Active mode:
 | |
|  *          1. Disable all LVD's and HVD's in active mode;
 | |
|  *          2. Disable Glitch detect;
 | |
|  *          3. Configure LDO's and DCDC to low drive strength in active mode;
 | |
|  *          4. Invoke this function to disable bandgap in active mode;
 | |
|  *      otherwise the error status will be reported.
 | |
|  *
 | |
|  * @note Some other system resources(such as PLL, CMP) require bandgap to be enabled, to disable bandgap please
 | |
|  * take care of other system resources.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param mode The Bandgap mode be selected.
 | |
|  *
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong The Bandgap can not be disabled in active mode.
 | |
|  * @retval #kStatus_Success Config Bandgap mode in Active power mode successful.
 | |
|  */
 | |
| status_t SPC_SetActiveModeBandgapModeConfig(SPC_Type *base, spc_bandgap_mode_t mode);
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT) && FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT)
 | |
| /*!
 | |
|  * @brief Enables/Disable the CMP Bandgap Buffer in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable CMP Bandgap buffer.
 | |
|  *          true    -   Enable Buffer Stored Reference voltage to CMP.
 | |
|  *          false   -   Disable Buffer Stored Reference voltage to CMP.
 | |
|  */
 | |
| static inline void SPC_EnableActiveModeCMPBandgapBuffer(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->ACTIVE_CFG |= SPC_ACTIVE_CFG_LPBUFF_EN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->ACTIVE_CFG &= ~SPC_ACTIVE_CFG_LPBUFF_EN_MASK;
 | |
|     }
 | |
| }
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT */
 | |
| 
 | |
| /*!
 | |
|  * @brief Sets the delay when the regulators change voltage level in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param delay The number of SPC timer clock cycles.
 | |
|  */
 | |
| static inline void SPC_SetActiveModeVoltageTrimDelay(SPC_Type *base, uint16_t delay)
 | |
| {
 | |
|     base->ACTIVE_VDELAY = SPC_ACTIVE_VDELAY_ACTIVE_VDELAY(delay);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs all settings of regulators in Active mode at a time.
 | |
|  *
 | |
|  * @note This function is used to overwrite all settings of regulators(including bandgap mode, regulators'
 | |
|  * drive strength and voltage level) in active mode at a time.
 | |
|  *
 | |
|  * @note Enable/disable LVDs/HVDs before invoking this function.
 | |
|  *
 | |
|  * @note This function will check input parameters based on hardware restrictions before setting registers, if input
 | |
|  * parameters do not satisfy hardware restrictions the specific error will be reported.
 | |
|  *
 | |
|  *
 | |
|  * @note Some hardware restrictions not covered, application should be aware of this and follow this hardware
 | |
|  * restrictions otherwise some unknown issue may occur:
 | |
|  *        1. If Core LDO's drive strength are set to same value in both Active mode and low power mode,
 | |
|  *          the voltage level should also set to same value.
 | |
|  *        2. When switching Core LDO's drive strength from low to normal, ensure the LDO_CORE high voltage level is set
 | |
|  *          to same level that was set prior to switching to the LDO_CORE drive strength. Otherwise, if the LVDs are
 | |
|  *          enabled, an unexpected LVD can occur.
 | |
|  *
 | |
|  * @note If this function can not satisfy some tricky settings, please invoke other APIs in low-level function group.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param config Pointer to spc_active_mode_regulators_config_t structure.
 | |
|  *
 | |
|  * @retval #kStatus_Success Config regulators in Active power mode successful.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong Based on input setting, bandgap can not be disabled.
 | |
|  * @retval #kStatus_SPC_Busy The SPC instance is busy to execute any type of power mode transition.
 | |
|  * @retval #kStatus_SPC_CORELDOLowDriveStrengthIgnore Any of LVDs/HVDs kept enabled before invoking this function.
 | |
|  * @retval #kStatus_SPC_SYSLDOOverDriveVoltageFail Fail to regulator to Over Drive Voltage due to
 | |
|  *                                                  System VDD HVD is not disabled.
 | |
|  * @retval #kStatus_SPC_SYSLDOLowDriveStrengthIgnore Any of LVDs/HVDs kept enabled before invoking this function.
 | |
|  * @retval #kStatus_SPC_CORELDOVoltageWrong Core LDO and System LDO do not have same voltage level.
 | |
|  */
 | |
| status_t SPC_SetActiveModeRegulatorsConfig(SPC_Type *base, const spc_active_mode_regulators_config_t *config);
 | |
| 
 | |
| #if !(defined(FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT) && FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT)
 | |
| /*!
 | |
|  * @brief Disables/Enables VDD Core Glitch Detect in Active mode.
 | |
|  *
 | |
|  * @note State of glitch detect disable feature will be ignored if bandgap is disabled and
 | |
|  * glitch detect hardware will be forced to OFF state.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param disable Used to disable/enable VDD Core Glitch detect feature.
 | |
|  *         - \b true Disable VDD Core Low Voltage detect;
 | |
|  *         - \b false Enable VDD Core Low Voltage detect.
 | |
|  */
 | |
| static inline void SPC_DisableActiveModeVddCoreGlitchDetect(SPC_Type *base, bool disable)
 | |
| {
 | |
|     if (disable)
 | |
|     {
 | |
|         base->ACTIVE_CFG |= SPC_ACTIVE_CFG_GLITCH_DETECT_DISABLE_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->ACTIVE_CFG &= ~SPC_ACTIVE_CFG_GLITCH_DETECT_DISABLE_MASK;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Check if Glitch detect hardware is enabled in active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return Indicate if Glitch detector is enabled.
 | |
|  */
 | |
| static inline bool SPC_CheckActiveModeVddCoreGlitchDetectEnabled(SPC_Type *base)
 | |
| {
 | |
|     if ((base->ACTIVE_CFG & SPC_ACTIVE_CFG_GLITCH_DETECT_DISABLE_MASK) == 0UL)
 | |
|     {
 | |
|         return true;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         return false;
 | |
|     }
 | |
| }
 | |
| 
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT */
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables analog modules in active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param maskValue The mask of analog modules to enable in active mode, should be the OR'ed value
 | |
|  * of @ref spc_analog_module_control.
 | |
|  */
 | |
| static inline void SPC_EnableActiveModeAnalogModules(SPC_Type *base, uint32_t maskValue)
 | |
| {
 | |
|     base->ACTIVE_CFG1 |= SPC_ACTIVE_CFG1_SOC_CNTRL(maskValue);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Disables analog modules in active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param maskValue The mask of analog modules to disable in active mode, should be the OR'ed value
 | |
|  * of @ref spc_analog_module_control.
 | |
|  */
 | |
| static inline void SPC_DisableActiveModeAnalogModules(SPC_Type *base, uint32_t maskValue)
 | |
| {
 | |
|     base->ACTIVE_CFG1 &= ~SPC_ACTIVE_CFG1_SOC_CNTRL(maskValue);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets enabled analog modules that enabled in active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  *
 | |
|  * @return The mask of enabled analog modules that enabled in active mode.
 | |
|  */
 | |
| static inline uint32_t SPC_GetActiveModeEnabledAnalogModules(SPC_Type *base)
 | |
| {
 | |
|     return base->ACTIVE_CFG1;
 | |
| }
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| /*!
 | |
|  * @name Low Power mode configuration
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets the Bandgap mode in Low Power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return Bandgap mode in the type of @ref spc_bandgap_mode_t enumeration.
 | |
|  */
 | |
| static inline spc_bandgap_mode_t SPC_GetLowPowerModeBandgapMode(SPC_Type *base)
 | |
| {
 | |
|     return (spc_bandgap_mode_t)(uint32_t)((base->LP_CFG & SPC_LP_CFG_BGMODE_MASK) >> SPC_LP_CFG_BGMODE_SHIFT);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets the status of all voltage detectors in Low Power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return The status of all voltage detectors in low power mode.
 | |
|  */
 | |
| static inline uint32_t SPC_GetLowPowerModeVoltageDetectStatus(SPC_Type *base)
 | |
| {
 | |
|     uint32_t state;
 | |
|     state = base->LP_CFG & (
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD) && FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD)
 | |
|                                SPC_LP_CFG_IO_HVDE_MASK | SPC_LP_CFG_IO_LVDE_MASK |
 | |
| 
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD */
 | |
|                                SPC_LP_CFG_SYS_HVDE_MASK | SPC_LP_CFG_SYS_LVDE_MASK | SPC_LP_CFG_CORE_LVDE_MASK
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD) && FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD)
 | |
|                                | SPC_LP_CFG_CORE_HVDE_MASK
 | |
| 
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD */
 | |
|                            );
 | |
|     return state;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables Low Power IREF in low power modes.
 | |
|  *
 | |
|  * This function enables/disables Low Power IREF. Low Power IREF can only get
 | |
|  * disabled in Deep power down mode. In other low power modes, the Low Power IREF
 | |
|  * is always enabled.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable Low Power IREF.
 | |
|  *          true    -   Enable Low Power IREF for Low Power modes.
 | |
|  *          false   -   Disable Low Power IREF for Deep Power Down mode.
 | |
|  */
 | |
| static inline void SPC_EnableLowPowerModeLowPowerIREF(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->LP_CFG |= SPC_LP_CFG_LP_IREFEN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->LP_CFG &= ~SPC_LP_CFG_LP_IREFEN_MASK;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs Bandgap mode in Low Power mode.
 | |
|  *
 | |
|  * @note To disable Bandgap in Low-power mode:
 | |
|  *          1. Disable all LVD's ad HVD's in low power mode;
 | |
|  *          2. Disable Glitch detect in low power mode;
 | |
|  *          3. Configure LDO's and DCDC to low drive strength in low power mode;
 | |
|  *          4. Disable bandgap in low power mode;
 | |
|  *      Otherwise, the error status will be reported.
 | |
|  *
 | |
|  * @note Some other system resources(such as PLL, CMP) require bandgap to be enabled, to disable bandgap please
 | |
|  * take care of other system resources.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param mode The Bandgap mode be selected.
 | |
|  *
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong The bandgap mode setting in Low Power mode is wrong.
 | |
|  * @retval #kStatus_Success Config Bandgap mode in Low Power power mode successful.
 | |
|  */
 | |
| status_t SPC_SetLowPowerModeBandgapmodeConfig(SPC_Type *base, spc_bandgap_mode_t mode);
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SRAMLDO_DPD_ON_BIT) && FSL_FEATURE_MCX_SPC_HAS_SRAMLDO_DPD_ON_BIT)
 | |
| /*!
 | |
|  * @brief Enables/disables SRAM_LDO deep power low power IREF.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Used to enable/disable low power IREF :
 | |
|  *        - \b true: Low Power IREF is enabled ;
 | |
|  *        - \b false: Low Power IREF is disabled for power saving.
 | |
|  */
 | |
| static inline void SPC_EnableSRAMLdOLowPowerModeIREF(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->LP_CFG |= SPC_LP_CFG_SRAMLDO_DPD_ON_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->LP_CFG &= ~SPC_LP_CFG_SRAMLDO_DPD_ON_MASK;
 | |
|     }
 | |
| }
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_SRAMLDO_DPD_ON_BIT */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT) && FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT)
 | |
| /*!
 | |
|  * @brief Enables/Disables CMP Bandgap Buffer.
 | |
|  *
 | |
|  * This function gates CMP bandgap buffer. CMP bandgap buffer is automatically disabled and turned off
 | |
|  * in Deep Power Down mode.
 | |
|  *
 | |
|  * @deprecated No longer used, please use SPC_EnableLowPowerModeCMPBandgapBuffer as instead.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable CMP Bandgap buffer.
 | |
|  *          true    -   Enable Buffer Stored Reference Voltage to CMP.
 | |
|  *          false   -   Disable Buffer Stored Reference Voltage to CMP.
 | |
|  */
 | |
| static inline void SPC_EnableLowPowerModeCMPBandgapBufferMode(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->LP_CFG |= SPC_LP_CFG_LPBUFF_EN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->LP_CFG &= ~SPC_LP_CFG_LPBUFF_EN_MASK;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables CMP Bandgap Buffer.
 | |
|  *
 | |
|  * This function gates CMP bandgap buffer. CMP bandgap buffer is automatically disabled and turned off
 | |
|  * in Deep Power Down mode.
 | |
|  *
 | |
|  * @deprecated No longer used.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable CMP Bandgap buffer.
 | |
|  *          true    -   Enable Buffer Stored Reference Voltage to CMP.
 | |
|  *          false   -   Disable Buffer Stored Reference Voltage to CMP.
 | |
|  */
 | |
| static inline void SPC_EnableLowPowerModeCMPBandgapBuffer(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->LP_CFG |= SPC_LP_CFG_LPBUFF_EN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->LP_CFG &= ~SPC_LP_CFG_LPBUFF_EN_MASK;
 | |
|     }
 | |
| }
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_LPBUFF_EN_BIT */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_COREVDD_IVS_EN_BIT) && FSL_FEATURE_MCX_SPC_HAS_COREVDD_IVS_EN_BIT)
 | |
| /*!
 | |
|  * @brief Enables/Disables CORE VDD IVS(Internal Voltage Scaling) in power down modes.
 | |
|  *
 | |
|  * This function gates CORE VDD IVS. When enabled, the IVS regulator will scale the
 | |
|  * external input CORE VDD to a lower voltage level to reduce internal leakage.
 | |
|  * IVS is invalid in Sleep or Deep power down mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable IVS.
 | |
|  *          true    -   enable CORE VDD IVS in Power Down mode.
 | |
|  *          false   -   disable CORE VDD IVS in Power Down mode.
 | |
|  */
 | |
| static inline void SPC_EnableLowPowerModeCoreVDDInternalVoltageScaling(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->LP_CFG |= SPC_LP_CFG_COREVDD_IVS_EN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->LP_CFG &= ~SPC_LP_CFG_COREVDD_IVS_EN_MASK;
 | |
|     }
 | |
| }
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_COREVDD_IVS_EN_BIT */
 | |
| 
 | |
| /*!
 | |
|  * @brief Sets the delay when exit the low power modes.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param delay The number of SPC timer clock cycles that the SPC waits on exit from low power modes.
 | |
|  */
 | |
| static inline void SPC_SetLowPowerWakeUpDelay(SPC_Type *base, uint16_t delay)
 | |
| {
 | |
|     base->LPWKUP_DELAY = SPC_LPWKUP_DELAY_LPWKUP_DELAY(delay);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs all settings of regulators in Low power mode at a time.
 | |
|  *
 | |
|  * @note This function is used to overwrite all settings of regulators(including bandgap mode, regulators'
 | |
|  * drive strength and voltage level) in low power mode at a time.
 | |
|  *
 | |
|  * @note Enable/disable LVDs/HVDs before invoking this function.
 | |
|  *
 | |
|  * @note This function will check input parameters based on hardware restrictions before setting registers, if input
 | |
|  * parameters do not satisfy hardware restrictions the specific error will be reported.
 | |
|  *
 | |
|  * @note Some hardware restrictions not covered, application should be aware of this and follow this hardware
 | |
|  * restrictions otherwise some unknown issue may occur:
 | |
|  *        1. If Core LDO's drive strength are set to same value in both Active mode and low power mode,
 | |
|  *          the voltage level should also set to same value.
 | |
|  *        2. When switching Core LDO's drive strength from low to normal, ensure the LDO_CORE high voltage level is set
 | |
|  *          to same level that was set prior to switching to the LDO_CORE drive strength. Otherwise, if the LVDs are
 | |
|  *          enabled, an unexpected LVD can occur.
 | |
|  *
 | |
|  * @note If this function can not satisfy some tricky settings, please invoke other APIs in low-level function group.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param config Pointer to spc_lowpower_mode_regulators_config_t structure.
 | |
|  * @retval #kStatus_Success Config regulators in Low power mode successful.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong The bandgap should not be disabled based on input settings.
 | |
|  * @retval #kStatus_SPC_CORELDOLowDriveStrengthIgnore Set driver strength to low will be ignored.
 | |
|  * @retval #kStatus_SPC_SYSLDOLowDriveStrengthIgnore Set driver strength to low will be ignored.
 | |
|  * @retval #kStatus_SPC_CORELDOVoltageWrong Core LDO and System LDO do not have same voltage level.
 | |
|  */
 | |
| status_t SPC_SetLowPowerModeRegulatorsConfig(SPC_Type *base, const spc_lowpower_mode_regulators_config_t *config);
 | |
| 
 | |
| #if !(defined(FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT) && FSL_FEATURE_MCX_SPC_HAS_NO_GLITCH_DETECT)
 | |
| /*!
 | |
|  * @brief Disable/Enable VDD Core Glitch Detect in low power mode.
 | |
|  *
 | |
|  * @note State of glitch detect disable feature will be ignored if bandgap is disabled and
 | |
|  * glitch detect hardware will be forced to OFF state.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param disable Used to disable/enable VDD Core Glitch detect feature.
 | |
|  *         - \b true Disable VDD Core Low Voltage detect;
 | |
|  *         - \b false Enable VDD Core Low Voltage detect.
 | |
|  */
 | |
| static inline void SPC_DisableLowPowerModeVddCoreGlitchDetect(SPC_Type *base, bool disable)
 | |
| {
 | |
|     if (disable)
 | |
|     {
 | |
|         base->LP_CFG |= SPC_LP_CFG_GLITCH_DETECT_DISABLE_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->LP_CFG &= ~SPC_LP_CFG_GLITCH_DETECT_DISABLE_MASK;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Check if Glitch detect hardware is enabled in low power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return Indicate if Glitch detector is enabled.
 | |
|  */
 | |
| static inline bool SPC_CheckLowPowerModeVddCoreGlitchDetectEnabled(SPC_Type *base)
 | |
| {
 | |
|     if ((base->LP_CFG & SPC_LP_CFG_GLITCH_DETECT_DISABLE_MASK) == 0UL)
 | |
|     {
 | |
|         return true;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         return false;
 | |
|     }
 | |
| }
 | |
| #endif
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables analog modules in low power modes.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param maskValue The mask of analog modules to enable in low power modes, should be OR'ed value
 | |
|                     of @ref spc_analog_module_control.
 | |
|  */
 | |
| static inline void SPC_EnableLowPowerModeAnalogModules(SPC_Type *base, uint32_t maskValue)
 | |
| {
 | |
|     base->LP_CFG1 |= SPC_LP_CFG1_SOC_CNTRL(maskValue);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Disables analog modules in low power modes.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param maskValue The mask of analog modules to disable in low power modes, should be OR'ed value
 | |
|                     of @ref spc_analog_module_control.
 | |
|  */
 | |
| static inline void SPC_DisableLowPowerModeAnalogModules(SPC_Type *base, uint32_t maskValue)
 | |
| {
 | |
|     base->LP_CFG1 &= ~SPC_LP_CFG1_SOC_CNTRL(maskValue);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets enabled analog modules that enabled in low power modes.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  *
 | |
|  * @return The mask of enabled analog modules that enabled in low power modes.
 | |
|  */
 | |
| static inline uint32_t SPC_GetLowPowerModeEnabledAnalogModules(SPC_Type *base)
 | |
| {
 | |
|     return base->LP_CFG1;
 | |
| }
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| /*!
 | |
|  * @name Voltage Detect Status
 | |
|  * @{
 | |
|  */
 | |
| /*!
 | |
|  * @brief Get Voltage Detect Status Flags.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return Voltage Detect Status Flags. See @ref _spc_voltage_detect_flags for details.
 | |
|  */
 | |
| static inline uint8_t SPC_GetVoltageDetectStatusFlag(SPC_Type *base)
 | |
| {
 | |
|     return (uint8_t)(base->VD_STAT);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Clear Voltage Detect Status Flags.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param mask The mask of the voltage detect status flags. See @ref _spc_voltage_detect_flags for details.
 | |
|  */
 | |
| static inline void SPC_ClearVoltageDetectStatusFlag(SPC_Type *base, uint8_t mask)
 | |
| {
 | |
|     base->VD_STAT |= mask;
 | |
| }
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| /*!
 | |
|  * @name Voltage Detect configuration for Core voltage domain.
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs CORE voltage detect options.
 | |
|  *
 | |
|  * @note: Setting both the voltage detect interrupt and reset
 | |
|  *       enable will cause interrupt to be generated on exit from reset.
 | |
|  *       If those conditioned is not desired, interrupt/reset so only one is enabled.
 | |
|  *
 | |
|  * @param base       SPC peripheral base address.
 | |
|  * @param config     Pointer to spc_core_voltage_detect_config_t structure.
 | |
|  */
 | |
| void SPC_SetCoreVoltageDetectConfig(SPC_Type *base, const spc_core_voltage_detect_config_t *config);
 | |
| 
 | |
| /*!
 | |
|  * @brief Locks Core voltage detect reset setting.
 | |
|  *
 | |
|  * This function locks core voltage detect reset setting. After invoking this function
 | |
|  * any configuration of Core voltage detect reset will be ignored.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_LockCoreVoltageDetectResetSetting(SPC_Type *base)
 | |
| {
 | |
|     base->VD_CORE_CFG |= SPC_VD_CORE_CFG_LOCK_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Unlocks Core voltage detect reset setting.
 | |
|  *
 | |
|  * This function unlocks core voltage detect reset setting. If locks the Core
 | |
|  * voltage detect reset setting, invoking this function to unlock.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_UnlockCoreVoltageDetectResetSetting(SPC_Type *base)
 | |
| {
 | |
|     base->VD_CORE_CFG &= ~SPC_VD_CORE_CFG_LOCK_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the Core Low Voltage Detector in Active mode.
 | |
|  *
 | |
|  * @note If the CORE_LDO low voltage detect is enabled in Active mode, please note that the bandgap must be enabled
 | |
|  * and the drive strength of each regulator must not set to low.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable Core LVD.
 | |
|  *          true    -   Enable Core Low voltage detector in active mode.
 | |
|  *          false   -   Disable Core Low voltage detector in active mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable/Disable Core Low Voltage Detect successfully.
 | |
|  */
 | |
| status_t SPC_EnableActiveModeCoreLowVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the Core Low Voltage Detector in Low Power mode.
 | |
|  *
 | |
|  * This function enables/disables the Core Low Voltage Detector.
 | |
|  * If enabled the Core Low Voltage detector. The Bandgap mode in
 | |
|  * low power mode must be programmed so that Bandgap is enabled.
 | |
|  *
 | |
|  * @note If the CORE_LDO low voltage detect is enabled in Low Power mode, please note that the bandgap must be enabled
 | |
|  * and the drive strength of each regulator must not set to low in Low Power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable Core HVD.
 | |
|  *          true    -   Enable Core Low voltage detector in low power mode.
 | |
|  *          false   -   Disable Core Low voltage detector in low power mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable/Disable Core Low Voltage Detect in low power mode successfully.
 | |
|  */
 | |
| status_t SPC_EnableLowPowerModeCoreLowVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD) && FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD)
 | |
| /*!
 | |
|  * @brief Enables/Disables the Core High Voltage Detector in Active mode.
 | |
|  *
 | |
|  * @note If the CORE_LDO high voltage detect is enabled in Active mode, please note that the bandgap must be enabled
 | |
|  * and the drive strength of each regulator must not set to low.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable Core HVD.
 | |
|  *          true    -   Enable Core High voltage detector in active mode.
 | |
|  *          false   -   Disable Core High voltage detector in active mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable/Disable Core High Voltage Detect successfully.
 | |
|  */
 | |
| status_t SPC_EnableActiveModeCoreHighVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the Core High Voltage Detector in Low Power mode.
 | |
|  *
 | |
|  * This function enables/disables the Core High Voltage Detector.
 | |
|  * If enabled the Core High Voltage detector. The Bandgap mode in
 | |
|  * low power mode must be programmed so that Bandgap is enabled.
 | |
|  *
 | |
|  * @note If the CORE_LDO high voltage detect is enabled in Low Power mode, please note that the bandgap must be enabled
 | |
|  * and the drive strength of each regulator must not set to low in low power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable Core HVD.
 | |
|  *          true    -   Enable Core High voltage detector in low power mode.
 | |
|  *          false   -   Disable Core High voltage detector in low power mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable/Disable Core High Voltage Detect in low power mode successfully.
 | |
|  */
 | |
| status_t SPC_EnableLowPowerModeCoreHighVoltageDetect(SPC_Type *base, bool enable);
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_COREVDD_HVD */
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| /*!
 | |
|  * @name Voltage detect configuration for System Voltage domain
 | |
|  * @{
 | |
|  */
 | |
| /*!
 | |
|  * @brief Set system VDD Low-voltage level selection.
 | |
|  *
 | |
|  * This function selects the system VDD low-voltage level. Changing system VDD low-voltage level
 | |
|  * must be done after disabling the System VDD low voltage reset and interrupt.
 | |
|  *
 | |
|  * @deprecated In latest RM, reserved for all devices, will removed in next release.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param level System VDD Low-Voltage level selection.
 | |
|  */
 | |
| void SPC_SetSystemVDDLowVoltageLevel(SPC_Type *base, spc_low_voltage_level_select_t level);
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs SYS voltage detect options.
 | |
|  *
 | |
|  * This function config SYS voltage detect options.
 | |
|  * @note: Setting both the voltage detect interrupt and reset
 | |
|  *       enable will cause interrupt to be generated on exit from reset.
 | |
|  *       If those conditioned is not desired, interrupt/reset so only one is enabled.
 | |
|  *
 | |
|  * @param base       SPC peripheral base address.
 | |
|  * @param config     Pointer to spc_system_voltage_detect_config_t structure.
 | |
|  */
 | |
| void SPC_SetSystemVoltageDetectConfig(SPC_Type *base, const spc_system_voltage_detect_config_t *config);
 | |
| 
 | |
| /*!
 | |
|  * @brief Lock System voltage detect reset setting.
 | |
|  *
 | |
|  * This function locks system voltage detect reset setting. After invoking this function
 | |
|  * any configuration of System Voltage detect reset will be ignored.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_LockSystemVoltageDetectResetSetting(SPC_Type *base)
 | |
| {
 | |
|     base->VD_SYS_CFG |= SPC_VD_SYS_CFG_LOCK_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Unlock System voltage detect reset setting.
 | |
|  *
 | |
|  * This function unlocks system voltage detect reset setting. If locks the System
 | |
|  * voltage detect reset setting, invoking this function to unlock.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_UnlockSystemVoltageDetectResetSetting(SPC_Type *base)
 | |
| {
 | |
|     base->VD_SYS_CFG &= ~SPC_VD_SYS_CFG_LOCK_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the System High Voltage Detector in Active mode.
 | |
|  *
 | |
|  * @note If the System_LDO high voltage detect is enabled in Active mode, please note that the bandgap must be enabled
 | |
|  * and the drive strength of each regulator must not set to low in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable System HVD.
 | |
|  *          true    -   Enable System High voltage detector in active mode.
 | |
|  *          false   -   Disable System High voltage detector in active mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable/Disable System High Voltage Detect successfully.
 | |
|  */
 | |
| status_t SPC_EnableActiveModeSystemHighVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disable the System Low Voltage Detector in Active mode.
 | |
|  *
 | |
|  * @note If the System_LDO low voltage detect is enabled in Active mode,
 | |
|  * please note that the bandgap must be enabled and the drive strength of each
 | |
|  * regulator must not set to low in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable System LVD.
 | |
|  *          true    -   Enable System Low voltage detector in active mode.
 | |
|  *          false   -   Disable System Low voltage detector in active mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable/Disable the System Low Voltage Detect successfully.
 | |
|  */
 | |
| status_t SPC_EnableActiveModeSystemLowVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the System High Voltage Detector in Low Power mode.
 | |
|  *
 | |
|  * @note If the System_LDO high voltage detect is enabled in Low Power mode, please note
 | |
|  * that the bandgap must be enabled and the drive strength of each regulator must
 | |
|  * not set to low in Low Power  mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable System HVD.
 | |
|  *          true    -   Enable System High voltage detector in low power mode.
 | |
|  *          false   -   Disable System High voltage detector in low power mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable/Disable System High Voltage Detect in low power mode successfully.
 | |
|  */
 | |
| status_t SPC_EnableLowPowerModeSystemHighVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the System Low Voltage Detector in Low Power mode.
 | |
|  *
 | |
|  * @note If the System_LDO low voltage detect is enabled in Low Power mode,
 | |
|  * please note that the bandgap must be enabled and the drive strength of each
 | |
|  * regulator must not set to low in Low Power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable System HVD.
 | |
|  *          true    -   Enable System Low voltage detector in low power mode.
 | |
|  *          false   -   Disable System Low voltage detector in low power mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enables System Low Voltage Detect in low power mode successfully.
 | |
|  */
 | |
| status_t SPC_EnableLowPowerModeSystemLowVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD) && FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD)
 | |
| /*!
 | |
|  * @name Voltage detect configuration for IO voltage domain
 | |
|  * @{
 | |
|  */
 | |
| /*!
 | |
|  * @brief Set IO VDD Low-Voltage level selection.
 | |
|  *
 | |
|  * This function selects the IO VDD Low-voltage level. Changing IO VDD low-voltage level
 | |
|  * must be done after disabling the IO VDD low voltage reset and interrupt.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param level IO VDD Low-voltage level selection.
 | |
|  */
 | |
| void SPC_SetIOVDDLowVoltageLevel(SPC_Type *base, spc_low_voltage_level_select_t level);
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs IO voltage detect options.
 | |
|  *
 | |
|  * This function config IO voltage detect options.
 | |
|  * @note: Setting both the voltage detect interrupt and reset
 | |
|  *       enable will cause interrupt to be generated on exit from reset.
 | |
|  *       If those conditioned is not desired, interrupt/reset so only one is enabled.
 | |
|  *
 | |
|  * @param base       SPC peripheral base address.
 | |
|  * @param config     Pointer to spc_voltage_detect_config_t structure.
 | |
|  */
 | |
| void SPC_SetIOVoltageDetectConfig(SPC_Type *base, const spc_io_voltage_detect_config_t *config);
 | |
| 
 | |
| /*!
 | |
|  * @brief Lock IO Voltage detect reset setting.
 | |
|  *
 | |
|  * This function locks IO voltage detect reset setting. After invoking this function
 | |
|  * any configuration of system voltage detect reset will be ignored.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_LockIOVoltageDetectResetSetting(SPC_Type *base)
 | |
| {
 | |
|     base->VD_IO_CFG |= SPC_VD_IO_CFG_LOCK_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Unlock IO voltage detect reset setting.
 | |
|  *
 | |
|  * This function unlocks IO voltage detect reset setting. If locks the IO
 | |
|  * voltage detect reset setting, invoking this function to unlock.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_UnlockIOVoltageDetectResetSetting(SPC_Type *base)
 | |
| {
 | |
|     base->VD_IO_CFG &= ~SPC_VD_IO_CFG_LOCK_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the IO High Voltage Detector in Active mode.
 | |
|  *
 | |
|  * @note If the IO high voltage detect is enabled in Active mode, please note that the bandgap must be enabled
 | |
|  * and the drive strength of each regulator must not set to low in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable IO HVD.
 | |
|  *          true    -   Enable IO High voltage detector in active mode.
 | |
|  *          false   -   Disable IO High voltage detector in active mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable/Disable IO High Voltage Detect successfully.
 | |
|  */
 | |
| status_t SPC_EnableActiveModeIOHighVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the IO Low Voltage Detector in Active mode.
 | |
|  *
 | |
|  * @note If the IO low voltage detect is enabled in Active mode, please note that the bandgap must be enabled
 | |
|  * and the drive strength of each regulator must not set to low in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable IO LVD.
 | |
|  *          true    -   Enable IO Low voltage detector in active mode.
 | |
|  *          false   -   Disable IO Low voltage detector in active mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable IO Low Voltage Detect successfully.
 | |
|  */
 | |
| status_t SPC_EnableActiveModeIOLowVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the IO High Voltage Detector in Low Power mode.
 | |
|  *
 | |
|  * @note If the IO high voltage detect is enabled in Low Power mode, please note that the bandgap must be enabled
 | |
|  * and the drive strength of each regulator must not set to low in Low Power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable IO HVD.
 | |
|  *          true    -   Enable IO High voltage detector in low power mode.
 | |
|  *          false   -   Disable IO High voltage detector in low power mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable IO High Voltage Detect in low power mode successfully.
 | |
|  */
 | |
| status_t SPC_EnableLowPowerModeIOHighVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*!
 | |
|  * @brief Enables/Disables the IO Low Voltage Detector in Low Power mode.
 | |
|  *
 | |
|  * @note If the IO low voltage detect is enabled in Low Power mode, please note that the bandgap must be enabled
 | |
|  * and the drive strength of each regulator must not set to low in Low Power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable IO LVD.
 | |
|  *          true    -   Enable IO Low voltage detector in low power mode.
 | |
|  *          false   -   Disable IO Low voltage detector in low power mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Enable/Disable IO Low Voltage Detect in low power mode successfully.
 | |
|  */
 | |
| status_t SPC_EnableLowPowerModeIOLowVoltageDetect(SPC_Type *base, bool enable);
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_IOVDD_VD */
 | |
| 
 | |
| /*!
 | |
|  * @name External Voltage domains configuration
 | |
|  * @{
 | |
|  */
 | |
| /*!
 | |
|  * @brief Configs external voltage domains
 | |
|  *
 | |
|  * This function configs external voltage domains isolation.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param lowPowerIsoMask The mask of external domains isolate enable during low power mode. Please read the Reference
 | |
|  * Manual for the Bitmap.
 | |
|  * @param IsoMask The mask of external domains isolate. Please read the Reference Manual for the Bitmap.
 | |
|  */
 | |
| void SPC_SetExternalVoltageDomainsConfig(SPC_Type *base, uint8_t lowPowerIsoMask, uint8_t IsoMask);
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets External Domains status.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return The status of each external domain.
 | |
|  */
 | |
| static inline uint8_t SPC_GetExternalDomainsStatus(SPC_Type *base)
 | |
| {
 | |
|     return (uint8_t)(base->EVD_CFG >> SPC_EVD_CFG_REG_EVDSTAT_SHIFT);
 | |
| }
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| /*!
 | |
|  * @name Low Level APIs To Set CORE LDO Regulator
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_CNTRL_REG) && FSL_FEATURE_MCX_SPC_HAS_CNTRL_REG)
 | |
| /*!
 | |
|  * @brief Enable/Disable Core LDO regulator.
 | |
|  *
 | |
|  * @note The CORE LDO enable bit is write-once.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable CORE LDO Regulator.
 | |
|  *          true   -   Enable CORE LDO Regulator.
 | |
|  *          false  -   Disable CORE LDO Regulator.
 | |
|  */
 | |
| static inline void SPC_EnableCoreLDORegulator(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->CNTRL |= SPC_CNTRL_CORELDO_EN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         /*
 | |
|          * $Branch Coverage Justification$
 | |
|          * If CORE_LDO is disabled, all RAMs data will powered off.
 | |
|          */
 | |
|         base->CNTRL &= ~SPC_CNTRL_CORELDO_EN_MASK;
 | |
|     }
 | |
| }
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_CNTRL_REG */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_DPDOWN_PULLDOWN_DISABLE_BIT) && \
 | |
|      FSL_FEATURE_MCX_SPC_HAS_DPDOWN_PULLDOWN_DISABLE_BIT)
 | |
| /*!
 | |
|  * @brief Enable/Disable the CORE LDO Regulator pull down in Deep Power Down.
 | |
|  *
 | |
|  * @note This function only useful when enabled the CORE LDO Regulator.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param pulldown Enable/Disable CORE LDO pulldown in Deep Power Down mode.
 | |
|  *          true    -   CORE LDO Regulator will discharge in Deep Power Down mode.
 | |
|  *          false   -   CORE LDO Regulator will not discharge in Deep Power Down mode.
 | |
|  */
 | |
| static inline void SPC_PullDownCoreLDORegulator(SPC_Type *base, bool pulldown)
 | |
| {
 | |
|     if (pulldown)
 | |
|     {
 | |
|         base->CORELDO_CFG &= ~SPC_CORELDO_CFG_DPDOWN_PULLDOWN_DISABLE_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->CORELDO_CFG |= SPC_CORELDO_CFG_DPDOWN_PULLDOWN_DISABLE_MASK;
 | |
|     }
 | |
| }
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_DPDOWN_PULLDOWN_DISABLE_BIT */
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs Core LDO Regulator in Active mode.
 | |
|  *
 | |
|  * @note The bandgap must be enabled before invoking this function.
 | |
|  * @note To set Core LDO as low drive strength, all HVDs/LVDs must be disabled previously.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param option Pointer to the spc_active_mode_core_ldo_option_t structure.
 | |
|  *
 | |
|  * @retval kStatus_Success Config Core LDO regulator in Active power mode successful.
 | |
|  * @retval kStatus_SPC_Busy The SPC instance is busy to execute any type of power mode transition.
 | |
|  * @retval kStatus_SPC_BandgapModeWrong Bandgap should be enabled before invoking this function.
 | |
|  * @retval kStatus_SPC_CORELDOLowDriveStrengthIgnore To set Core LDO as low drive strength,
 | |
|  *                                                  all LVDs/HVDs must be disabled before invoking this function.
 | |
|  */
 | |
| status_t SPC_SetActiveModeCoreLDORegulatorConfig(SPC_Type *base, const spc_active_mode_core_ldo_option_t *option);
 | |
| 
 | |
| /*!
 | |
|  * @brief Set Core LDO Regulator Voltage level in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param voltageLevel Specify the voltage level of CORE LDO Regulator in Active mode, please
 | |
|         refer to @ref spc_core_ldo_voltage_level_t.
 | |
|  *
 | |
|  * @note In active mode, the Core LDO voltage level should only be changed when the
 | |
|  *  Core LDO is in normal drive strength.
 | |
|  *
 | |
|  * @note Update Core LDO voltage level will set Busy flag,
 | |
|  *      this function return only when busy flag is cleared by hardware
 | |
|  *
 | |
|  * @retval kStatus_SPC_CORELDOVoltageSetFail  The drive strength of Core LDO is not normal.
 | |
|  * @retval kStatus_Success Set Core LDO regulator voltage level in Active power mode successful.
 | |
|  */
 | |
| status_t SPC_SetActiveModeCoreLDORegulatorVoltageLevel(SPC_Type *base, spc_core_ldo_voltage_level_t voltageLevel);
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets CORE LDO Regulator Voltage level.
 | |
|  *
 | |
|  * This function returns the voltage level of CORE LDO Regulator in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return Voltage level of CORE LDO in type of @ref spc_core_ldo_voltage_level_t enumeration.
 | |
|  */
 | |
| static inline spc_core_ldo_voltage_level_t SPC_GetActiveModeCoreLDOVDDVoltageLevel(SPC_Type *base)
 | |
| {
 | |
|     return (spc_core_ldo_voltage_level_t)(uint32_t)((base->ACTIVE_CFG & SPC_ACTIVE_CFG_CORELDO_VDD_LVL_MASK) >>
 | |
|                                                     SPC_ACTIVE_CFG_CORELDO_VDD_LVL_SHIFT);
 | |
| }
 | |
| 
 | |
| #if (defined(FSL_FEATURE_SPC_HAS_CORELDO_VDD_DS) && FSL_FEATURE_SPC_HAS_CORELDO_VDD_DS)
 | |
| /*!
 | |
|  * @brief Set Core LDO VDD Regulator Drive Strength in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param driveStrength Specify the drive strength of CORE LDO Regulator in Active mode, please
 | |
|         refer to @ref spc_core_ldo_drive_strength_t.
 | |
|  *
 | |
|  * @retval #kStatus_Success Set Core LDO regulator drive strength in Active power mode successful.
 | |
|  * @retval #kStatus_SPC_CORELDOLowDriveStrengthIgnore If any voltage detect enabled,
 | |
|             core_ldo's drive strength can not set to low.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong The selected bandgap mode is not allowed.
 | |
|  */
 | |
| status_t SPC_SetActiveModeCoreLDORegulatorDriveStrength(SPC_Type *base, spc_core_ldo_drive_strength_t driveStrength);
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets CORE LDO VDD Regulator Drive Strength in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return Drive Strength of CORE LDO regulator in Active mode, please refer to @ref spc_core_ldo_drive_strength_t.
 | |
|  */
 | |
| static inline spc_core_ldo_drive_strength_t SPC_GetActiveModeCoreLDODriveStrength(SPC_Type *base)
 | |
| {
 | |
|     return (spc_core_ldo_drive_strength_t)(uint32_t)((base->ACTIVE_CFG & SPC_ACTIVE_CFG_CORELDO_VDD_DS_MASK) >>
 | |
|                                                      SPC_ACTIVE_CFG_CORELDO_VDD_DS_SHIFT);
 | |
| }
 | |
| #endif /* defined(FSL_FEATURE_SPC_HAS_CORELDO_VDD_DS) && FSL_FEATURE_SPC_HAS_CORELDO_VDD_DS */
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs CORE LDO Regulator in low power mode
 | |
|  *
 | |
|  * This function configs CORE LDO Regulator in Low Power mode.
 | |
|  * If CORE LDO VDD Drive Strength is set to Normal, the CORE LDO VDD regulator voltage
 | |
|  * level in Active mode must be equal to the voltage level in Low power mode. And the Bandgap
 | |
|  * must be programmed to select bandgap enabled.
 | |
|  * Core VDD voltage levels for the Core LDO low power regulator can only be changed when the CORE
 | |
|  * LDO Drive Strength set as Normal.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param option Pointer to the spc_lowpower_mode_core_ldo_option_t structure.
 | |
|  *
 | |
|  * @retval #kStatus_Success Config Core LDO regulator in power mode successfully.
 | |
|  * @retval #kStatus_SPC_Busy The SPC instance is busy to execute any type of power mode transition.
 | |
|  * @retval #kStatus_SPC_CORELDOLowDriveStrengthIgnore Set driver strength to low will be ignored.
 | |
|  * @retval #kStatus_SPC_CORELDOVoltageSetFail. Fail to change Core LDO voltage level.
 | |
|  */
 | |
| status_t SPC_SetLowPowerModeCoreLDORegulatorConfig(SPC_Type *base, const spc_lowpower_mode_core_ldo_option_t *option);
 | |
| 
 | |
| /*!
 | |
|  * @brief Set Core LDO VDD Regulator Voltage level in Low power mode.
 | |
|  *
 | |
|  * @note If CORE LDO's drive strength is set to Normal, the CORE LDO VDD regulator voltage in active mode and low power
 | |
|  *  mode must be same.
 | |
|  * @note Voltage level for the CORE LDO in low power mode can only be changed when the CORE LDO Drive Strength set as
 | |
|  * Normal.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param voltageLevel Voltage level of CORE LDO Regulator in Low power mode, please
 | |
|         refer to @ref spc_core_ldo_voltage_level_t.
 | |
|  *
 | |
|  * @retval #kStatus_SPC_CORELDOVoltageWrong Voltage level in active mode and low power mode is not same.
 | |
|  * @retval #kStatus_Success Set Core LDO regulator voltage level in Low power mode successful.
 | |
|  * @retval #kStatus_SPC_CORELDOVoltageSetFail Fail to update voltage level because drive strength is incorrect.
 | |
|  */
 | |
| status_t SPC_SetLowPowerModeCoreLDORegulatorVoltageLevel(SPC_Type *base, spc_core_ldo_voltage_level_t voltageLevel);
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets the CORE LDO VDD Regulator Voltage Level for Low Power modes.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return The CORE LDO VDD Regulator's voltage level.
 | |
|  */
 | |
| static inline spc_core_ldo_voltage_level_t SPC_GetLowPowerCoreLDOVDDVoltageLevel(SPC_Type *base)
 | |
| {
 | |
|     return ((spc_core_ldo_voltage_level_t)(uint32_t)((base->LP_CFG & SPC_LP_CFG_CORELDO_VDD_LVL_MASK) >>
 | |
|                                                      SPC_LP_CFG_CORELDO_VDD_LVL_SHIFT));
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Set Core LDO VDD Regulator Drive Strength in Low power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param driveStrength Specify drive strength of CORE LDO in low power mode.
 | |
|  *
 | |
|  * @retval #kStatus_SPC_CORELDOLowDriveStrengthIgnore Some voltage detect enabled, CORE LDO's drive strength can not set
 | |
|  *           as low.
 | |
|  * @retval #kStatus_Success Set Core LDO regulator drive strength in Low power mode successful.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong Bandgap is disabled when attempt to set CORE LDO work as normal drive strength.
 | |
|  */
 | |
| status_t SPC_SetLowPowerModeCoreLDORegulatorDriveStrength(SPC_Type *base, spc_core_ldo_drive_strength_t driveStrength);
 | |
| 
 | |
| /*!
 | |
|  * @brief Gets CORE LDO VDD Drive Strength for Low Power modes.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return The CORE LDO's VDD Drive Strength.
 | |
|  */
 | |
| static inline spc_core_ldo_drive_strength_t SPC_GetLowPowerCoreLDOVDDDriveStrength(SPC_Type *base)
 | |
| {
 | |
|     return (spc_core_ldo_drive_strength_t)(uint32_t)((base->LP_CFG & SPC_LP_CFG_CORELDO_VDD_DS_MASK) >>
 | |
|                                                      SPC_LP_CFG_CORELDO_VDD_DS_SHIFT);
 | |
| }
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_SYS_LDO) && FSL_FEATURE_MCX_SPC_HAS_SYS_LDO)
 | |
| /*!
 | |
|  * @name Low Level APIs To Set System LDO Regulator
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*!
 | |
|  * @brief Enable/Disable System LDO regulator.
 | |
|  *
 | |
|  * @note The SYSTEM LDO enable bit is write-once.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable System LDO Regulator.
 | |
|  *          true     -   Enable System LDO Regulator.
 | |
|  *          false    -    Disable System LDO Regulator.
 | |
|  */
 | |
| static inline void SPC_EnableSystemLDORegulator(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->CNTRL |= SPC_CNTRL_SYSLDO_EN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         /*
 | |
|          * $Branch Coverage Justification$
 | |
|          * If SYSTEM_LDO is disabled, may cause some unexpected issues.
 | |
|          */
 | |
|         base->CNTRL &= ~SPC_CNTRL_SYSLDO_EN_MASK;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Enable/Disable current sink feature of System LDO Regulator.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param sink Enable/Disable current sink feature.
 | |
|  *          true    -   Enable current sink feature of System LDO Regulator.
 | |
|  *          false   -   Disable current sink feature of System LDO Regulator.
 | |
|  */
 | |
| static inline void SPC_EnableSystemLDOSinkFeature(SPC_Type *base, bool sink)
 | |
| {
 | |
|     if (sink)
 | |
|     {
 | |
|         base->SYSLDO_CFG |= SPC_SYSLDO_CFG_ISINKEN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->SYSLDO_CFG &= ~SPC_SYSLDO_CFG_ISINKEN_MASK;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs System LDO VDD Regulator in Active mode.
 | |
|  *
 | |
|  * @note If System LDO VDD Drive Strength is set to Normal, the Bandgap mode in Active mode must be programmed
 | |
|  * to a value that enables the bandgap.
 | |
|  * @note If any voltage detects are kept enabled, configuration to set System LDO VDD drive strength to low will
 | |
|  * be ignored.
 | |
|  * @note If select System LDO VDD Regulator voltage level to Over Drive Voltage, the Drive Strength of System LDO VDD
 | |
|  * Regulator must be set to Normal otherwise the regulator Drive Strength will be forced to Normal.
 | |
|  * @note If select System LDO VDD Regulator voltage level to Over Drive Voltage, the High voltage detect must be
 | |
|  * disabled. Otherwise it will be fail to regulator to Over Drive Voltage.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param option Pointer to the spc_active_mode_sys_ldo_option_t structure.
 | |
|  *
 | |
|  * @retval #kStatus_Success Config System LDO regulator in Active power mode successful.
 | |
|  * @retval #kStatus_SPC_Busy The SPC instance is busy to execute any type of power mode transition.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong The bandgap is not enabled before invoking this function.
 | |
|  * @retval #kStatus_SPC_SYSLDOOverDriveVoltageFail HVD of System VDD is not disable before setting to Over Drive
 | |
|  * voltage.
 | |
|  * @retval kStatus_SPC_SYSLDOLowDriveStrengthIgnore Set System LDO VDD regulator's driver strength to Low will be
 | |
|  * ignored.
 | |
|  */
 | |
| status_t SPC_SetActiveModeSystemLDORegulatorConfig(SPC_Type *base, const spc_active_mode_sys_ldo_option_t *option);
 | |
| 
 | |
| /*!
 | |
|  * @brief Set System LDO Regulator voltage level in Active mode.
 | |
|  *
 | |
|  * @note The system LDO regulator can only operate at the overdrive voltage level for a limited amount of time for the
 | |
|  * life of chip.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param voltageLevel Specify the voltage level of System LDO Regulator in Active mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Set System LDO Regulator voltage level in Active mode successfully.
 | |
|  * @retval #kStatus_SPC_SYSLDOOverDriveVoltageFail Must disable system LDO high voltage detector before specifying
 | |
|  * overdrive voltage.
 | |
|  */
 | |
| status_t SPC_SetActiveModeSystemLDORegulatorVoltageLevel(SPC_Type *base, spc_sys_ldo_voltage_level_t voltageLevel);
 | |
| 
 | |
| /*!
 | |
|  * @brief Get System LDO Regulator voltage level in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return System LDO Regulator voltage level in Active mode, please refer to @ref spc_sys_ldo_voltage_level_t.
 | |
|  */
 | |
| static inline spc_sys_ldo_voltage_level_t SPC_GetActiveModeSystemLDORegulatorVoltageLevel(SPC_Type *base)
 | |
| {
 | |
|     return (spc_sys_ldo_voltage_level_t)(uint32_t)((base->ACTIVE_CFG & SPC_ACTIVE_CFG_SYSLDO_VDD_LVL_MASK) >>
 | |
|                                                    SPC_ACTIVE_CFG_SYSLDO_VDD_LVL_SHIFT);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Set System LDO Regulator Drive Strength in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param driveStrength Specify the drive strength  of System LDO Regulator in Active mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Set System LDO Regulator drive strength in Active mode successfully.
 | |
|  * @retval #kStatus_SPC_SYSLDOLowDriveStrengthIgnore Attempt to specify low drive strength is ignored due to any
 | |
|             voltage detect feature is enabled in active mode.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong Bandgap mode in Active mode must be programmed to a value that enables
 | |
|             the bandgap if attempt to specify normal drive strength.
 | |
|  */
 | |
| status_t SPC_SetActiveModeSystemLDORegulatorDriveStrength(SPC_Type *base, spc_sys_ldo_drive_strength_t driveStrength);
 | |
| 
 | |
| /*!
 | |
|  * @brief Get System LDO Regulator Drive Strength in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return System LDO regulator drive strength in Active mode, please refer to @ref spc_sys_ldo_drive_strength_t.
 | |
|  */
 | |
| static inline spc_sys_ldo_drive_strength_t SPC_GetActiveModeSystemLDORegulatorDriveStrength(SPC_Type *base)
 | |
| {
 | |
|     return (spc_sys_ldo_drive_strength_t)(uint32_t)((base->ACTIVE_CFG & SPC_ACTIVE_CFG_SYSLDO_VDD_DS_MASK) >>
 | |
|                                                     SPC_ACTIVE_CFG_SYSLDO_VDD_DS_SHIFT);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs System LDO regulator in low power modes.
 | |
|  *
 | |
|  * This function configs System LDO regulator in low power modes.
 | |
|  * If System LDO VDD Regulator Drive strength is set to normal, bandgap mode in low power
 | |
|  * mode must be programmed to a value that enables the Bandgap.
 | |
|  * If any High voltage detectors or Low Voltage detectors are kept enabled, configuration
 | |
|  * to set System LDO Regulator drive strength as Low will be ignored.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param option Pointer to spc_lowpower_mode_sys_ldo_option_t structure.
 | |
|  *
 | |
|  * @retval #kStatus_Success Config System LDO regulator in Low Power Mode successfully.
 | |
|  * @retval #kStatus_SPC_Busy The SPC instance is busy to execute any type of power mode transition.
 | |
|  * @retval #kStatus_SPC_SYSLDOLowDriveStrengthIgnore Set driver strength to low will be ignored.
 | |
|  */
 | |
| status_t SPC_SetLowPowerModeSystemLDORegulatorConfig(SPC_Type *base, const spc_lowpower_mode_sys_ldo_option_t *option);
 | |
| 
 | |
| /*!
 | |
|  * @brief Set System LDO Regulator drive strength in Low Power Mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param driveStrength Specify the drive strength of System LDO Regulator in Low Power Mode.
 | |
|  *
 | |
|  * @retval #kStatus_Success Set System LDO Regulator drive strength in Low Power Mode successfully.
 | |
|  * @retval #kStatus_SPC_SYSLDOLowDriveStrengthIgnore Attempt to specify low drive strength is ignored due to any
 | |
|             voltage detect feature is enabled in low power mode.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong Bandgap mode in low power mode must be programmed to a value that enables
 | |
|             the bandgap if attempt to specify normal drive strength.
 | |
|  */
 | |
| status_t SPC_SetLowPowerModeSystemLDORegulatorDriveStrength(SPC_Type *base, spc_sys_ldo_drive_strength_t driveStrength);
 | |
| 
 | |
| /*!
 | |
|  * @brief Get System LDO Regulator drive strength in Low Power Mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return System LDO regulator drive strength in Low Power Mode, please refer to @ref spc_sys_ldo_drive_strength_t.
 | |
|  */
 | |
| static inline spc_sys_ldo_drive_strength_t SPC_GetLowPowerModeSystemLDORegulatorDriveStrength(SPC_Type *base)
 | |
| {
 | |
|     return (spc_sys_ldo_drive_strength_t)(uint32_t)((base->LP_CFG & SPC_LP_CFG_SYSLDO_VDD_DS_MASK) >>
 | |
|                                                     SPC_LP_CFG_SYSLDO_VDD_DS_SHIFT);
 | |
| }
 | |
| /*! @} */
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_SYS_LDO */
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_DCDC) && FSL_FEATURE_MCX_SPC_HAS_DCDC)
 | |
| /*!
 | |
|  * @name Low Level APIs To Set DCDC Regulator
 | |
|  * @{
 | |
|  */
 | |
| 
 | |
| /*!
 | |
|  * @brief Enable/Disable DCDC Regulator.
 | |
|  *
 | |
|  * @note The DCDC enable bit is write-once, settings only reset after a POR, LVD, or HVD event.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Enable/Disable DCDC Regulator.
 | |
|  *          true    -   Enable DCDC Regulator.
 | |
|  *          false   -   Disable DCDC Regulator.
 | |
|  */
 | |
| static inline void SPC_EnableDCDCRegulator(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->CNTRL |= SPC_CNTRL_DCDC_EN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         /*
 | |
|          * $Branch Coverage Justification$
 | |
|          * If DCDC is disabled, all RAMs data will powered off.
 | |
|          */
 | |
|         base->CNTRL &= ~SPC_CNTRL_DCDC_EN_MASK;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Config DCDC Burst options
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param config Pointer to spc_dcdc_burst_config_t structure.
 | |
|  */
 | |
| void SPC_SetDCDCBurstConfig(SPC_Type *base, spc_dcdc_burst_config_t *config);
 | |
| 
 | |
| /*!
 | |
|  * @brief Trigger a software burst request to DCDC.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  */
 | |
| static inline void SPC_TriggerDCDCBurstRequest(SPC_Type *base)
 | |
| {
 | |
|     /* Blocking until previous DCDC burst completed. */
 | |
|     while ((base->DCDC_BURST_CFG & SPC_DCDC_BURST_CFG_BURST_ACK_MASK) == 0UL)
 | |
|     {
 | |
|     }
 | |
| 
 | |
|     base->DCDC_BURST_CFG |= SPC_DCDC_BURST_CFG_BURST_REQ_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Check if burst acknowledge flag is asserted.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  *
 | |
|  * @retval false DCDC burst not complete.
 | |
|  * @retval true DCDC burst complete.
 | |
|  */
 | |
| static inline bool SPC_CheckDCDCBurstAck(SPC_Type *base)
 | |
| {
 | |
|     return ((base->DCDC_BURST_CFG & SPC_DCDC_BURST_CFG_BURST_ACK_MASK) != 0UL);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Clear DCDC busrt acknowledge flag.
 | |
|  *
 | |
|  * @param base SPC periphral base address.
 | |
|  */
 | |
| static inline void SPC_ClearDCDCBurstAckFlag(SPC_Type *base)
 | |
| {
 | |
|     base->DCDC_BURST_CFG |= SPC_DCDC_BURST_CFG_BURST_ACK_MASK;
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Set the count value of the reference clock to configure the period of DCDC not active.
 | |
|  *
 | |
|  * @note This function is only useful when DCDC's drive strength is set as pulse refresh.
 | |
|  * @note The pulse duration(time between on and off) is: reference clock period * (count + 2).
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param count The count value, 16 bit width.
 | |
|  */
 | |
| void SPC_SetDCDCRefreshCount(SPC_Type *base, uint16_t count);
 | |
| 
 | |
| #if (defined(FSL_FEATURE_MCX_SPC_HAS_DCDC_CFG_BLEED_EN) && FSL_FEATURE_MCX_SPC_HAS_DCDC_CFG_BLEED_EN)
 | |
| /*!
 | |
|  * @brief Enable a bleed resistor to discharge DCDC output when DCDC is disabled.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param enable Used to enable/disable bleed resistor.
 | |
|  */
 | |
| static inline void SPC_EnableDCDCBleedResistor(SPC_Type *base, bool enable)
 | |
| {
 | |
|     if (enable)
 | |
|     {
 | |
|         base->DCDC_CFG |= SPC_DCDC_CFG_BLEED_EN_MASK;
 | |
|     }
 | |
|     else
 | |
|     {
 | |
|         base->DCDC_CFG &= ~SPC_DCDC_CFG_BLEED_EN_MASK;
 | |
|     }
 | |
| }
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_DCDC_CFG_BLEED_EN */
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs DCDC_CORE Regulator in Active mode.
 | |
|  *
 | |
|  * @note When changing the DCDC output voltage level, take care to change the CORE LDO voltage level.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param option Pointer to the spc_active_mode_dcdc_option_t structure.
 | |
|  *
 | |
|  * @retval #kStatus_Success Config DCDC regulator in Active power mode successful.
 | |
|  * @retval #kStatus_SPC_Busy The SPC instance is busy to execute any type of power mode transition.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong Set DCDC_CORE Regulator drive strength to Normal, the Bandgap must be enabled.
 | |
|  */
 | |
| status_t SPC_SetActiveModeDCDCRegulatorConfig(SPC_Type *base, const spc_active_mode_dcdc_option_t *option);
 | |
| 
 | |
| /*!
 | |
|  * @brief Set DCDC_CORE Regulator voltage level in Active mode.
 | |
|  *
 | |
|  * @note When changing the DCDC output voltage level, take care to change the CORE LDO voltage level.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param voltageLevel Specify the DCDC_CORE Regulator voltage level, please refer to @ref spc_dcdc_voltage_level_t.
 | |
|  */
 | |
| static inline void SPC_SetActiveModeDCDCRegulatorVoltageLevel(SPC_Type *base, spc_dcdc_voltage_level_t voltageLevel)
 | |
| {
 | |
|     base->ACTIVE_CFG =
 | |
|         (base->ACTIVE_CFG & (~SPC_ACTIVE_CFG_DCDC_VDD_LVL_MASK)) | SPC_ACTIVE_CFG_DCDC_VDD_LVL(voltageLevel);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Get DCDC_CORE Regulator voltage level in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return DCDC_CORE Regulator voltage level, please refer to @ref spc_dcdc_voltage_level_t.
 | |
|  */
 | |
| static inline spc_dcdc_voltage_level_t SPC_GetActiveModeDCDCRegulatorVoltageLevel(SPC_Type *base)
 | |
| {
 | |
|     return (spc_dcdc_voltage_level_t)((uint32_t)((base->ACTIVE_CFG & SPC_ACTIVE_CFG_DCDC_VDD_LVL_MASK) >>
 | |
|                                                  SPC_ACTIVE_CFG_DCDC_VDD_LVL_SHIFT));
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Set DCDC_CORE Regulator drive strength in Active mode.
 | |
|  *
 | |
|  * @note To set DCDC drive strength as Normal, the bandgap must be enabled.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param driveStrength Specify the DCDC_CORE regulator drive strength, please refer to @ref spc_dcdc_drive_strength_t.
 | |
|  *
 | |
|  * @retval #kStatus_Success Set DCDC_CORE Regulator drive strength in Active mode successfully.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong Set DCDC_CORE Regulator drive strength to Normal, the Bandgap must be enabled.
 | |
|  */
 | |
| status_t SPC_SetActiveModeDCDCRegulatorDriveStrength(SPC_Type *base, spc_dcdc_drive_strength_t driveStrength);
 | |
| 
 | |
| /*!
 | |
|  * @brief Get DCDC_CORE Regulator drive strength in Active mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return DCDC_CORE Regulator drive strength, please refer to @ref spc_dcdc_drive_strength_t.
 | |
|  */
 | |
| static inline spc_dcdc_drive_strength_t SPC_GetActiveModeDCDCRegulatorDriveStrength(SPC_Type *base)
 | |
| {
 | |
|     return (spc_dcdc_drive_strength_t)((uint32_t)((base->ACTIVE_CFG & SPC_ACTIVE_CFG_DCDC_VDD_DS_MASK) >>
 | |
|                                                   SPC_ACTIVE_CFG_DCDC_VDD_DS_SHIFT));
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Configs DCDC_CORE Regulator in Low power modes.
 | |
|  *
 | |
|  * @note If DCDC_CORE Drive Strength is set to Normal, the Bandgap mode in Low Power mode must be programmed
 | |
|  * to a value that enables the Bandgap.
 | |
|  * @note In Deep Power Down mode, DCDC regulator is always turned off.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param option Pointer to the spc_lowpower_mode_dcdc_option_t structure.
 | |
|  *
 | |
|  * @retval #kStatus_Success Config DCDC regulator in low power mode successfully.
 | |
|  * @retval #kStatus_SPC_Busy The SPC instance is busy to execute any type of power mode transition.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong The bandgap mode setting in Low Power mode is wrong.
 | |
|  */
 | |
| status_t SPC_SetLowPowerModeDCDCRegulatorConfig(SPC_Type *base, const spc_lowpower_mode_dcdc_option_t *option);
 | |
| 
 | |
| /*!
 | |
|  * @brief Set DCDC_CORE Regulator drive strength in Low power mode.
 | |
|  *
 | |
|  * @note To set drive strength as normal, the bandgap must be enabled.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param driveStrength Specify the DCDC_CORE Regulator drive strength, please refer to @ref spc_dcdc_drive_strength_t.
 | |
|  *
 | |
|  * @retval #kStatus_Success Set DCDC_CORE Regulator drive strength in Low power mode successfully.
 | |
|  * @retval #kStatus_SPC_BandgapModeWrong Set DCDC_CORE Regulator drive strength to Normal, the Bandgap must be enabled.
 | |
|  */
 | |
| status_t SPC_SetLowPowerModeDCDCRegulatorDriveStrength(SPC_Type *base, spc_dcdc_drive_strength_t driveStrength);
 | |
| 
 | |
| /*!
 | |
|  * @brief Get DCDC_CORE Regulator drive strength in Low power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return DCDC_CORE Regulator drive strength, please refer to @ref spc_dcdc_drive_strength_t.
 | |
|  */
 | |
| static inline spc_dcdc_drive_strength_t SPC_GetLowPowerModeDCDCRegulatorDriveStrength(SPC_Type *base)
 | |
| {
 | |
|     return (spc_dcdc_drive_strength_t)((uint32_t)((base->LP_CFG & SPC_LP_CFG_DCDC_VDD_DS_MASK) >>
 | |
|                                                   SPC_LP_CFG_DCDC_VDD_DS_SHIFT));
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Set DCDC_CORE Regulator voltage level in Low power mode.
 | |
|  *
 | |
|  * @note To change DCDC level in Low-Power mode:
 | |
|  *          1. Configure LP_CFG[DCDC_VDD_LVL] to desired level;
 | |
|  *          2. Configure LP_CFG[DCDC_VDD_DS] to low driver strength;
 | |
|  *  	    3. Configure ACTIVE_CFG[DCDC_VDD_LVL] to same level programmed in #1.
 | |
|  *
 | |
|  * @note After invoking this function, the voltage level in active mode(wakeup from low power modes) also changed,
 | |
|  * if it is necessary, please invoke SPC_SetActiveModeDCDCRegulatorVoltageLevel() to change to desried voltage level.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @param voltageLevel Specify the DCDC_CORE Regulator voltage level, please refer to @ref spc_dcdc_voltage_level_t.
 | |
|  */
 | |
| static inline void SPC_SetLowPowerModeDCDCRegulatorVoltageLevel(SPC_Type *base, spc_dcdc_voltage_level_t voltageLevel)
 | |
| {
 | |
|     base->LP_CFG = (base->LP_CFG & (~SPC_LP_CFG_DCDC_VDD_LVL_MASK)) | SPC_LP_CFG_DCDC_VDD_LVL(voltageLevel);
 | |
|     (void)SPC_SetLowPowerModeDCDCRegulatorDriveStrength(base, kSPC_DCDC_LowDriveStrength);
 | |
|     SPC_SetActiveModeDCDCRegulatorVoltageLevel(base, voltageLevel);
 | |
| }
 | |
| 
 | |
| /*!
 | |
|  * @brief Get DCDC_CORE Regulator voltage level in Low power mode.
 | |
|  *
 | |
|  * @param base SPC peripheral base address.
 | |
|  * @return DCDC_CORE Regulator voltage level, please refer to @ref spc_dcdc_voltage_level_t.
 | |
|  */
 | |
| static inline spc_dcdc_voltage_level_t SPC_GetLowPowerModeDCDCRegulatorVoltageLevel(SPC_Type *base)
 | |
| {
 | |
|     return (spc_dcdc_voltage_level_t)((uint32_t)((base->LP_CFG & SPC_LP_CFG_DCDC_VDD_LVL_MASK) >>
 | |
|                                                  SPC_LP_CFG_DCDC_VDD_LVL_SHIFT));
 | |
| }
 | |
| 
 | |
| /*! @} */
 | |
| #endif /* FSL_FEATURE_MCX_SPC_HAS_DCDC */
 | |
| 
 | |
| #if defined(__cplusplus)
 | |
| }
 | |
| #endif /* __cplusplus */
 | |
| 
 | |
| /*! @} */
 | |
| 
 | |
| #endif /* FSL_SPC_H_ */
 | 
