Low Power (LP)

Modules
	PWRSEQ_Registers

Enumerations
enum	mxc_lp_ovr_t
enum	mxc_lp_cfg_ds_pd_t

Functions
void	MXC_LP_EnterSleepMode (void)
void	MXC_LP_EnterDeepSleepMode (void)
void	MXC_LP_EnterBackupMode (void)
void	MXC_LP_EnterStorageMode (void)
void	MXC_LP_EnterShutDownMode (void)
int	MXC_LP_SetOVR (mxc_lp_ovr_t ovr)
void	MXC_LP_RetentionRegEnable (void)
void	MXC_LP_RetentionRegDisable (void)
int	MXC_LP_RetentionRegIsEnabled (void)
void	MXC_LP_BandgapOn (void)
void	MXC_LP_BandgapOff (void)
int	MXC_LP_BandgapIsOn (void)
void	MXC_LP_PORVCOREoreMonitorEnable (void)
void	MXC_LP_PORVCOREoreMonitorDisable (void)
int	MXC_LP_PORVCOREoreMonitorIsEnabled (void)
void	MXC_LP_LDOEnable (void)
void	MXC_LP_LDODisable (void)
int	MXC_LP_LDOIsEnabled (void)
void	MXC_LP_FastWakeupEnable (void)
void	MXC_LP_FastWakeupDisable (void)
int	MXC_LP_FastWakeupIsEnabled (void)
void	MXC_LP_ClearWakeStatus (void)
void	MXC_LP_EnableGPIOWakeup (mxc_gpio_cfg_t *wu_pins)
void	MXC_LP_DisableGPIOWakeup (mxc_gpio_cfg_t *wu_pins)
void	MXC_LP_EnableRTCAlarmWakeup (void)
void	MXC_LP_DisableRTCAlarmWakeup (void)
void	MXC_LP_EnableTimerWakeup (mxc_tmr_regs_t *tmr)
void	MXC_LP_DisableTimerWakeup (mxc_tmr_regs_t *tmr)
void	MXC_LP_EnableUARTWakeup (void)
void	MXC_LP_DisableUARTWakeup (void)
void	MXC_LP_EnableUSBWakeup (void)
void	MXC_LP_DisableUSBWakeup (void)
void	MXC_LP_EnableHA0Wakeup (void)
void	MXC_LP_DisableHA0Wakeup (void)
void	MXC_LP_EnableHA1Wakeup (void)
void	MXC_LP_DisableHA1Wakeup (void)
int	MXC_LP_ConfigDeepSleepClocks (uint32_t mask)
void	MXC_LP_NFCOscBypassEnable (void)
void	MXC_LP_NFCOscBypassDisable (void)
int	MXC_LP_NFCOscBypassIsEnabled (void)
void	MXC_LP_SysRam0LightSleepEnable (void)
void	MXC_LP_SysRam1LightSleepEnable (void)
void	MXC_LP_SysRam2LightSleepEnable (void)
void	MXC_LP_SysRam3LightSleepEnable (void)
void	MXC_LP_ICache0LightSleepEnable (void)
void	MXC_LP_ROMLightSleepEnable (void)
void	MXC_LP_SysRam0LightSleepDisable (void)
void	MXC_LP_SysRam1LightSleepDisable (void)
void	MXC_LP_SysRam2LightSleepDisable (void)
void	MXC_LP_SysRam3LightSleepDisable (void)
void	MXC_LP_ICache0LightSleepDisable (void)
void	MXC_LP_ROMLightSleepDisable (void)
void	MXC_LP_SysRam0Shutdown (void)
void	MXC_LP_SysRam0PowerUp (void)
void	MXC_LP_SysRam1Shutdown (void)
void	MXC_LP_SysRam1PowerUp (void)
void	MXC_LP_SysRam2Shutdown (void)
void	MXC_LP_SysRam2PowerUp (void)
void	MXC_LP_SysRam3Shutdown (void)
void	MXC_LP_SysRam3PowerUp (void)

Detailed Description

Enumeration Type Documentation

mxc_lp_ovr_t

enum mxc_lp_ovr_t

Enumeration type for voltage selection.

Enumerator
MXC_LP_OVR_0_9	OVR 0.9V
MXC_LP_OVR_1_0	OVR 1.0V
MXC_LP_OVR_1_1	OVR 1.1V

Function Documentation

MXC_LP_BandgapIsOn()

int MXC_LP_BandgapIsOn

(

void

)

Is the bandgap on or off.

Returns

1 = bandgap on , 0 = bandgap off

MXC_LP_ConfigDeepSleepClocks()

int MXC_LP_ConfigDeepSleepClocks

(

uint32_t

mask

)

Configure which clocks are powered down at deep sleep and which are not affected.

Note

Need to configure all clocks at once any clock not passed in the mask will be unaffected by Deepsleep. This will always overwrite the previous settings of ALL clocks.

Parameters

[in]

mask

The mask of the clocks to power down when part goes into deepsleep

Returns

E_NO_ERROR or error based on Error Codes

MXC_LP_DisableGPIOWakeup()

void MXC_LP_DisableGPIOWakeup

(

mxc_gpio_cfg_t *

wu_pins

)

Disables the selected GPIO port and its selected pins as a wake up source. Call this function multiple times to disable pins on multiple ports.

Parameters

wu_pins

The port and pins to disable as wakeup sources. Only the gpio and mask fields of the structure are used. The func and pad fields are ignored. mxc_gpio_cfg_t

MXC_LP_DisableTimerWakeup()

void MXC_LP_DisableTimerWakeup

(

mxc_tmr_regs_t *

tmr

)

Disables Timer from waking up device.

Parameters

tmr	Pointer to timer module.

MXC_LP_EnableGPIOWakeup()

void MXC_LP_EnableGPIOWakeup

(

mxc_gpio_cfg_t *

wu_pins

)

Enables the selected GPIO port and its selected pins to wake up the device from any low power mode. Call this function multiple times to enable pins on multiple ports. This function does not configure the GPIO pins nor does it setup their interrupt functionality.

Parameters

wu_pins

The port and pins to configure as wakeup sources. Only the gpio and mask fields of the structure are used. The func and pad fields are ignored. mxc_gpio_cfg_t

MXC_LP_EnableTimerWakeup()

void MXC_LP_EnableTimerWakeup

(

mxc_tmr_regs_t *

tmr

)

Enables Timer to wakeup from any low power mode.

Parameters

tmr	Pointer to timer module.

MXC_LP_FastWakeupIsEnabled()

int MXC_LP_FastWakeupIsEnabled

(

void

)

Is Fast wake up is Enabled.

Returns

1 = enabled , 0 = disabled

MXC_LP_LDOIsEnabled()

int MXC_LP_LDOIsEnabled

(

void

)

Is LDO enabled.

Returns

1 = enabled , 0 = disabled

MXC_LP_NFCOscBypassIsEnabled()

int MXC_LP_NFCOscBypassIsEnabled

(

void

)

Is NFC Oscilator Bypass Enabled.

Returns

1 = enabled, 0 = disabled

MXC_LP_PORVCOREoreMonitorIsEnabled()

int MXC_LP_PORVCOREoreMonitorIsEnabled

(

void

)

Is Power on Reset VDD Core Monitor enabled.

Returns

1 = enabled , 0 = disabled

MXC_LP_RetentionRegIsEnabled()

int MXC_LP_RetentionRegIsEnabled

(

void

)

Is the retention regulator enabled.

Returns

1 = enabled 0 = disabled

MXC_LP_SetOVR()

int MXC_LP_SetOVR

(

mxc_lp_ovr_t

ovr

)

Sets the operating voltage for the device. The caller must perform the peripheral reset after calling this function.

Parameters

[in]

ovr

The ovr options are only 0.9V, 1.0V, and 1.1V use enum mxc_lp_ovr_t

Returns

Success/Fail, see Error Codes for a list of return codes.