pmm

Functions
void	PMM_enableLowPowerReset (void)
	Enables the low power reset. SVSH does not reset device, but triggers a system NMI. More...
void	PMM_disableLowPowerReset (void)
	Disables the low power reset. SVSH resets device. More...
void	PMM_enableSVSH (void)
	Enables the high-side SVS circuitry. More...
void	PMM_disableSVSH (void)
	Disables the high-side SVS circuitry. More...
void	PMM_turnOnRegulator (void)
	Makes the low-dropout voltage regulator (LDO) remain ON when going into LPM 3/4. More...
void	PMM_turnOffRegulator (void)
	Turns OFF the low-dropout voltage regulator (LDO) when going into LPM3/4, thus the system will enter LPM3.5 or LPM4.5 respectively. More...
void	PMM_trigPOR (void)
	Calling this function will trigger a software Power On Reset (POR). More...
void	PMM_trigBOR (void)
	Calling this function will trigger a software Brown Out Rest (BOR). More...
void	PMM_clearInterrupt (uint16_t mask)
	Clears interrupt flags for the PMM. More...
uint16_t	PMM_getInterruptStatus (uint16_t mask)
	Returns interrupt status. More...
void	PMM_unlockLPM5 (void)
	Unlock LPM5. More...
uint16_t	PMM_getBandgapMode (void)
	Returns the bandgap mode of the PMM module. More...
uint16_t	PMM_isBandgapActive (void)
	Returns the active status of the bandgap in the PMM module. More...
uint16_t	PMM_isRefGenActive (void)
	Returns the active status of the reference generator in the PMM module. More...
uint16_t	PMM_getBufferedBandgapVoltageStatus (void)
	Returns the active status of the reference generator in the PMM module. More...
uint16_t	PMM_getVariableReferenceVoltageStatus (void)
	Returns the busy status of the variable reference voltage in the PMM module. More...
void	PMM_disableTempSensor (void)
	Disables the internal temperature sensor to save power consumption. More...
void	PMM_enableTempSensor (void)
	Enables the internal temperature sensor. More...
void	PMM_disableExternalReference (void)
	Disables the external reference output. More...
void	PMM_enableExternalReference (void)
	Enables the external reference output. More...
void	PMM_disableInternalReference (void)
	Disables the internal reference output. More...
void	PMM_enableInternalReference (void)
	Enables the internal reference output. More...

Detailed Description

Function Documentation

void PMM_clearInterrupt

(

uint16_t

mask

)

Clears interrupt flags for the PMM.

Parameters

mask

is the mask for specifying the required flag Mask value is the logical OR of any of the following: PMM_BOR_INTERRUPT - Software BOR interrupt PMM_RST_INTERRUPT - RESET pin interrupt PMM_POR_INTERRUPT - Software POR interrupt PMM_SVSH_INTERRUPT - SVS high side interrupt PMM_LPM5_INTERRUPT - LPM5 indication PMM_ALL - All interrupts

Modified bits of PMMCTL0 register and bits of PMMIFG register.

Returns

None

void PMM_disableExternalReference

(

void

)

Disables the external reference output.

This function is used to disable the external reference output. The external reference is connected to a given external ADC channel. The external reference is disabled by default.

Modified bits are EXTREFEN of PMMCTL2 register.

Returns

None

void PMM_disableInternalReference

(

void

)

Disables the internal reference output.

This function is used to disable the internal reference output. The internal reference is internally connected to the ADC channel. The internal reference is disabled by default.

Modified bits are INTREFEN of PMMCTL2 register.

Returns

None

void PMM_disableLowPowerReset

(

void

)

Disables the low power reset. SVSH resets device.

Modified bits of PMMCTL0 register.

Returns

None

void PMM_disableSVSH

(

void

)

Disables the high-side SVS circuitry.

Modified bits of PMMCTL0 register.

Returns

None

void PMM_disableTempSensor

(

void

)

Disables the internal temperature sensor to save power consumption.

This function is used to turn off the internal temperature sensor to save on power consumption. The temperature sensor is disabled by default.

Modified bits are TSENSOREN of PMMCTL2 register.

Returns

None

void PMM_enableExternalReference

(

void

)

Enables the external reference output.

This function is used to enable the external reference output. The external reference is connected to a given external ADC channel. The external reference is disabled by default.

Modified bits are EXTREFEN of PMMCTL2 register.

Returns

None

void PMM_enableInternalReference

(

void

)

Enables the internal reference output.

This function is used to enable the internal reference output. The internal reference is internally connected to the ADC channel. The internal reference is disabled by default.

Modified bits are INTREFEN of PMMCTL2 register.

Returns

None

void PMM_enableLowPowerReset

(

void

)

Enables the low power reset. SVSH does not reset device, but triggers a system NMI.

Modified bits of PMMCTL0 register.

Returns

None

void PMM_enableSVSH

(

void

)

Enables the high-side SVS circuitry.

Modified bits of PMMCTL0 register.

Returns

None

void PMM_enableTempSensor

(

void

)

Enables the internal temperature sensor.

This function is used to turn on the internal temperature sensor to use by other peripherals. The temperature sensor is disabled by default.

Modified bits are TSENSOREN of PMMCTL2 register.

Returns

None

uint16_t PMM_getBandgapMode

(

void

)

Returns the bandgap mode of the PMM module.

This function is used to return the bandgap mode of the PMM module, requested by the peripherals using the bandgap. If a peripheral requests static mode, then the bandgap mode will be static for all modules, whereas if all of the peripherals using the bandgap request sample mode, then that will be the mode returned. Sample mode allows the bandgap to be active only when necessary to save on power consumption, static mode requires the bandgap to be active until no peripherals are using it anymore.

Returns

The bandgap mode of the PMM module: Return Logical OR of any of the following:

• PMM_STATICMODE if the bandgap is operating in static mode
• PMM_SAMPLEMODE if the bandgap is operating in sample mode

uint16_t PMM_getBufferedBandgapVoltageStatus

(

void

)

Returns the active status of the reference generator in the PMM module.

This function is used to return the ready status of the buffered bandgap voltage in the PMM module. If the buffered bandgap voltage is ready to use, the ready status will be returned.

Returns

The buffered bandgap voltage ready status of the PMM module: Return Logical OR of any of the following:

• PMM_REFBG_NOTREADY if buffered bandgap voltage is NOT ready to be used
• PMM_REFBG_READY if buffered bandgap voltage ready to be used

uint16_t PMM_getInterruptStatus

(

uint16_t

mask

)

Returns interrupt status.

Parameters

mask

is the mask for specifying the required flag Mask value is the logical OR of any of the following: PMM_BOR_INTERRUPT - Software BOR interrupt PMM_RST_INTERRUPT - RESET pin interrupt PMM_POR_INTERRUPT - Software POR interrupt PMM_SVSH_INTERRUPT - SVS high side interrupt PMM_LPM5_INTERRUPT - LPM5 indication PMM_ALL - All interrupts

Returns

Logical OR of any of the following:

• PMM_BOR_INTERRUPT Software BOR interrupt
• PMM_RST_INTERRUPT RESET pin interrupt
• PMM_POR_INTERRUPT Software POR interrupt
• PMM_SVSH_INTERRUPT SVS high side interrupt
• PMM_LPM5_INTERRUPT LPM5 indication
• PMM_ALL All interrupts
  indicating the status of the selected interrupt flags

uint16_t PMM_getVariableReferenceVoltageStatus

(

void

)

Returns the busy status of the variable reference voltage in the PMM module.

This function is used to return the ready status of the variable reference voltage in the REFPMM module. If the reference generator is on and ready to use, then the ready status will be returned.

Returns

The variable reference voltage active status of the PMM module: Return Logical OR of any of the following:

• PMM_REFGEN_NOTREADY if variable reference voltage is NOT ready to be used
• PMM_REFGEN_READY if variable reference voltage ready to be used

uint16_t PMM_isBandgapActive

(

void

)

Returns the active status of the bandgap in the PMM module.

This function is used to return the active status of the bandgap in the PMM module. If the bandgap is in use by a peripheral, then the status will be seen as active.

Returns

The bandgap active status of the PMM module: Return Logical OR of any of the following:

• PMM_REFBG_INACTIVE if the bandgap is not being used at the time of query
• PMM_REFBG_ACTIVE if the bandgap is being used at the time of query

uint16_t PMM_isRefGenActive

(

void

)

Returns the active status of the reference generator in the PMM module.

This function is used to return the active status of the reference generator in the PMM module. If the reference generator is on and ready to use, then the status will be seen as active.

Returns

The reference generator active status of the PMM module: Return Logical OR of any of the following:

• PMM_REFGEN_INACTIVE if the reference generator is off and not operating
• PMM_REFGEN_ACTIVE if the reference generator is on and ready to be used

void PMM_trigBOR

(

void

)

Calling this function will trigger a software Brown Out Rest (BOR).

Modified bits of PMMCTL0 register.

Returns

None

void PMM_trigPOR

(

void

)

Calling this function will trigger a software Power On Reset (POR).

Modified bits of PMMCTL0 register.

Returns

None

void PMM_turnOffRegulator

(

void

)

Turns OFF the low-dropout voltage regulator (LDO) when going into LPM3/4, thus the system will enter LPM3.5 or LPM4.5 respectively.

Modified bits of PMMCTL0 register.

Returns

None

void PMM_turnOnRegulator

(

void

)

Makes the low-dropout voltage regulator (LDO) remain ON when going into LPM 3/4.

Modified bits of PMMCTL0 register.

Returns

None

void PMM_unlockLPM5

(

void

)

Unlock LPM5.

LPMx.5 configuration is not locked and defaults to its reset condition. Disable the GPIO power-on default high-impedance mode to activate previously configured port settings.

Returns

None