MSP430 DriverLib for MSP430FR5xx_6xx Devices  2.91.13.01
uups

Functions

void UUPS_clearInterrupt (uint16_t baseAddress, uint8_t mask)
 Clears UUPS interrupts. More...
 
void UUPS_enableInterrupt (uint16_t baseAddress, uint8_t mask)
 Enables UUPS interrupts. More...
 
void UUPS_disableInterrupt (uint16_t baseAddress, uint8_t mask)
 Disables selected UUPS interrupt sources. More...
 
uint8_t UUPS_getInterruptStatus (uint16_t baseAddress, uint16_t mask)
 Gets the current UUPS interrupt status. More...
 
void UUPS_stopMeasurement (uint16_t baseAddress)
 Stops USS measurement. More...
 
void UUPS_turnOffPower (uint16_t baseAddress)
 Turns down USS power. More...
 
void UUPS_turnOnPower (uint16_t baseAddress, uint16_t triggerSource)
 Turns on USS power and PLL. More...
 
void UUPS_enableASQ (uint16_t baseAddress)
 Enables USS acquistion sequencer (ASQ). More...
 
uint8_t UUPS_getPowerModeStatus (uint16_t baseAddress)
 Goes to the specified power mode. More...
 
uint8_t UUPS_isBusy (uint16_t baseAddress)
 Returns current USS busy status. More...
 
uint8_t UUPS_isLDOReady (uint16_t baseAddress)
 Returns whether USS LDO is ready. More...
 
void UUPS_setLowPowerBiasHoldOffDelay (uint16_t baseAddress, uint16_t holdOffDelay)
 Sets the low power bias hold off delay. More...
 
void UUPS_holdUSSInResetState (uint16_t baseAddress)
 Hold USS (and sub modules) logic in reset state. More...
 
void UUPS_releaseUSSFromResetState (uint16_t baseAddress)
 Release USS (and sub modules) from reset state for operation. More...
 

Detailed Description

Function Documentation

§ UUPS_clearInterrupt()

void UUPS_clearInterrupt ( uint16_t  baseAddress,
uint8_t  mask 
)

Clears UUPS interrupts.

The UUPS interrupt source is cleared, so that it no longer asserts. If the interrupt is not enabled, the corresponding bit in the RIS register bit will be cleared. If the interrupt is enabled, the corresponding bit both MIS and RIS registers will be both cleared.

Parameters
baseAddressis the base address of the UUPS module.
maskis the logical OR of any of the following:
  • UUPS_POWER_REQUEST_IGNORE_INTERRUPT - UUPS power request ignored interrupt
  • UUPS_POWER_UP_TIMEOUT_INTERRUPT - UUPS power up time out interrupt
Returns
None

§ UUPS_disableInterrupt()

void UUPS_disableInterrupt ( uint16_t  baseAddress,
uint8_t  mask 
)

Disables selected UUPS interrupt sources.

Disables the indicated UUPS interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.

Parameters
baseAddressis the base address of the UUPS module.
maskis the logical OR of any of the following:
  • UUPS_POWER_REQUEST_IGNORE_INTERRUPT - UUPS power request ignored interrupt
  • UUPS_POWER_UP_TIMEOUT_INTERRUPT - UUPS power up time out interrupt
Returns
None

§ UUPS_enableASQ()

void UUPS_enableASQ ( uint16_t  baseAddress)

Enables USS acquistion sequencer (ASQ).

This enable the USS acquistion sequencer (ASQ). ASQ must be enabled before applying a USS_PWRREQ signal.

Parameters
baseAddressis the base address of the UUPS module.
Returns
None

§ UUPS_enableInterrupt()

void UUPS_enableInterrupt ( uint16_t  baseAddress,
uint8_t  mask 
)

Enables UUPS interrupts.

Enables the indicated UUPS interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor. Does not clear interrupt flags.

Parameters
baseAddressis the base address of the UUPS module.
maskis the logical OR of any of the following:
  • UUPS_POWER_REQUEST_IGNORE_INTERRUPT - UUPS power request ignored interrupt
  • UUPS_POWER_UP_TIMEOUT_INTERRUPT - UUPS power up time out interrupt
Returns
None

§ UUPS_getInterruptStatus()

uint8_t UUPS_getInterruptStatus ( uint16_t  baseAddress,
uint16_t  mask 
)

Gets the current UUPS interrupt status.

This returns the interrupt status for the UUPS module based on which flag is passed.

Parameters
baseAddressis the base address of the UUPS module.
maskis the logical OR of any of the following:
  • UUPS_POWER_REQUEST_IGNORE_INTERRUPT - UUPS power request ignored interrupt
  • UUPS_POWER_UP_TIMEOUT_INTERRUPT - UUPS power up time out interrupt
Returns
Logical OR of any of the following:
  • UUPS_POWER_REQUEST_IGNORE_INTERRUPT - UUPS power request ignored interrupt
  • UUPS_POWER_UP_TIMEOUT_INTERRUPT - UUPS power up time out interrupt

§ UUPS_getPowerModeStatus()

uint8_t UUPS_getPowerModeStatus ( uint16_t  baseAddress)

Goes to the specified power mode.

This function makes USS go to the specified power mode.

Parameters
baseAddressis the base address of the UUPS module.
powerModeis the desired power mode to go to.
Returns
None Gets current USS power mode status.

This gets current USS power mode status.

Parameters
baseAddressis the base address of the UUPS module.
Returns
Any of the following:
  • UUPS_POWERMODE_OFF
  • UUPS_POWERMODE_READY
  • UUPS_POWERMODE_STANDBY
  • UUPS_POWERMODE_TIMEOUT

§ UUPS_holdUSSInResetState()

void UUPS_holdUSSInResetState ( uint16_t  baseAddress)

Hold USS (and sub modules) logic in reset state.

Useful if HSPLL gets stuck. Cycle USS into reset state with this function, and then release from reset state with UUPS_releaseUSSFromResetState. USS is default released from reset, and ready for operation (still required to be powered up).

Parameters
baseAddressis the base address of the UUPS module.
Returns
None

§ UUPS_isBusy()

uint8_t UUPS_isBusy ( uint16_t  baseAddress)

Returns current USS busy status.

This returns current USS busy status depending on whether USS is performing a measurement.

Parameters
baseAddressis the base address of the UUPS module.
Returns
UUPS_BUSY or UUPS_NOT_BUSY

§ UUPS_isLDOReady()

uint8_t UUPS_isLDOReady ( uint16_t  baseAddress)

Returns whether USS LDO is ready.

This returns USS LDO ready status.

Parameters
baseAddressis the base address of the UUPS module.
Returns
UUPS_LDO_READY or UUPS_LDO_NOT_READY

§ UUPS_releaseUSSFromResetState()

void UUPS_releaseUSSFromResetState ( uint16_t  baseAddress)

Release USS (and sub modules) from reset state for operation.

Useful if HSPLL gets stuck. Cycle USS into reset state with this UUPS_holdUSSInResetState, and then release from reset state with this function. USS is default released from reset, and ready for operation (still required to be powered up).

Parameters
baseAddressis the base address of the UUPS module.
Returns
None

§ UUPS_setLowPowerBiasHoldOffDelay()

void UUPS_setLowPowerBiasHoldOffDelay ( uint16_t  baseAddress,
uint16_t  holdOffDelay 
)

Sets the low power bias hold off delay.

Defines the duration of the hold off delay for low power bias mode. Low power bias mode can be enabled from SAPH module. The hold off delay is inserted from "OFF state" to "READY state" and from "STANDBY state" to "READY state". Affects extra delay in Register Mode and Auto Mode. Reset type: PUC

Parameters
baseAddressis the base address of the UUPS module.
holdOffDelayis the desired amount of additional hold off delay. 512 REFCLKS = ~100us, 1024 REFCLKS = ~200us, 1536 REFCLKS = ~300us. They map to the same values. Valid values are:
  • UUPS_HOLD_OFF_DELAY_ADDITIONAL_NONE
  • UUPS_HOLD_OFF_DELAY_ADDITIONAL_512_REFCLKS
  • UUPS_HOLD_OFF_DELAY_ADDITIONAL_1024_REFCLKS
  • UUPS_HOLD_OFF_DELAY_ADDITIONAL_1536_REFCLKS
  • UUPS_HOLD_OFF_DELAY_ADDITIONAL_100_US
  • UUPS_HOLD_OFF_DELAY_ADDITIONAL_200_US
  • UUPS_HOLD_OFF_DELAY_ADDITIONAL_300_US
Returns
None

§ UUPS_stopMeasurement()

void UUPS_stopMeasurement ( uint16_t  baseAddress)

Stops USS measurement.

This stops the USS current measurement.

Parameters
baseAddressis the base address of the UUPS module.
Returns
None

§ UUPS_turnOffPower()

void UUPS_turnOffPower ( uint16_t  baseAddress)

Turns down USS power.

This stops the current measurement and turn off USS module.

Parameters
baseAddressis the base address of the UUPS module.
Returns
None

§ UUPS_turnOnPower()

void UUPS_turnOnPower ( uint16_t  baseAddress,
uint16_t  triggerSource 
)

Turns on USS power and PLL.

This turns on USS power and PLL with specified power-up trigger source. When an external trigger source is selected, this function has no effect.

Parameters
baseAddressis the base address of the UUPS module.
triggerSourceis the specified power-up trigger source. Valid values are:
  • UUPS_POWERUP_TRIGGER_SOURCE_USSPWRUP
  • UUPS_POWERUP_TRIGGER_SOURCE_RTC
  • UUPS_POWERUP_TRIGGER_SOURCE_TIMER
  • UUPS_POWERUP_TRIGGER_SOURCE_EXTERNAL
Returns
None

Copyright 2020, Texas Instruments Incorporated