Defines | Functions
frpmm.h File Reference

Go to the source code of this file.

Defines

#define __MSP430_HAS_PMM_FR5xx__
#define __MSP430_HAS_PMM_FRAM__
#define FRPMM_PMMBORIFG   PMMBORIFG
#define FRPMM_PMMRSTIFG   PMMRSTIFG
#define FRPMM_PMMPORIFG   PMMPORIFG
#define FRPMM_SVSHIFG   SVSHIFG
#define FRPMM_SVSLIFG   SVSLIFG
#define FRPMM_PMMLPM5IFG   PMMLPM5IFG
#define FRPMM_ALL   (0xB7)
#define FRPMM_LPRST   PMMLPRST
#define FRPMM_SVSHE   SVSHE
#define FRPMM_SVSLE   SVSLE
#define FRPMM_PMMREGOFF   PMMREGOFF
#define FRPMM_PMMSWPOR   PMMSWPOR
#define FRPMM_PMMSWBOR   PMMSWBOR
#define FRPMM_LOCKLPM5   LOCKLPM5
#define FRPMM_PW   PMMPW
#define FRPMM_PW_H   PMMPW_H

Functions

void FRPMM_enableLowPowerReset (unsigned int baseAddress)
void FRPMM_disableLowPowerReset (unsigned int baseAddress)
void FRPMM_enableSVSH (unsigned int baseAddress)
void FRPMM_disableSVSH (unsigned int baseAddress)
void FRPMM_enableSVSL (unsigned int baseAddress)
void FRPMM_disableSVSL (unsigned int baseAddress)
void FRPMM_regOff (unsigned int baseAddress)
void FRPMM_regOn (unsigned int baseAddress)
void FRPMM_trigPOR (unsigned int baseAddress)
void FRPMM_trigBOR (unsigned int baseAddress)
void FRPMM_clearInterrupt (unsigned int baseAddress, unsigned int mask)
unsigned int FRPMM_getInterruptStatus (unsigned int baseAddress, unsigned int mask)
void FRPMM_lockLPM5 (unsigned int baseAddress)
void FRPMM_unlockLPM5 (unsigned int baseAddress)

Define Documentation

#define __MSP430_HAS_PMM_FR5xx__
#define __MSP430_HAS_PMM_FRAM__
#define FRPMM_PMMBORIFG   PMMBORIFG
#define FRPMM_PMMRSTIFG   PMMRSTIFG
#define FRPMM_PMMPORIFG   PMMPORIFG
#define FRPMM_SVSHIFG   SVSHIFG
#define FRPMM_SVSLIFG   SVSLIFG
#define FRPMM_PMMLPM5IFG   PMMLPM5IFG
#define FRPMM_ALL   (0xB7)
#define FRPMM_LPRST   PMMLPRST
#define FRPMM_SVSHE   SVSHE
#define FRPMM_SVSLE   SVSLE
#define FRPMM_PMMREGOFF   PMMREGOFF

Referenced by FRPMM_regOff(), and FRPMM_regOn().

#define FRPMM_PMMSWPOR   PMMSWPOR

Referenced by FRPMM_trigPOR().

#define FRPMM_PMMSWBOR   PMMSWBOR

Referenced by FRPMM_trigBOR().

#define FRPMM_LOCKLPM5   LOCKLPM5

Referenced by FRPMM_lockLPM5(), and FRPMM_unlockLPM5().

#define FRPMM_PW   PMMPW
#define FRPMM_PW_H   PMMPW_H

Function Documentation

void FRPMM_enableLowPowerReset ( unsigned int  baseAddress)

Enables the low power reset. SVSH does not reset device, but triggers a system NMI Note: only available for FR58xx and FR59xx devices

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_LPRST, FRPMM_PW_H, and HWREGB.

void FRPMM_disableLowPowerReset ( unsigned int  baseAddress)

Disables the low power reset. SVSH resets device. Note: only available for FR58xx and FR59xx devices

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_LPRST, FRPMM_PW_H, and HWREGB.

void FRPMM_enableSVSH ( unsigned int  baseAddress)

Enables the high-side SVS circuitry

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_PW_H, FRPMM_SVSHE, and HWREGB.

void FRPMM_disableSVSH ( unsigned int  baseAddress)

Disables the high-side SVS circuitry

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_PW_H, FRPMM_SVSHE, and HWREGB.

void FRPMM_enableSVSL ( unsigned int  baseAddress)

Enables the low-side SVS circuitry Note: only available for FR57xx devices

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_PW_H, FRPMM_SVSLE, and HWREGB.

void FRPMM_disableSVSL ( unsigned int  baseAddress)

Disables the low-side SVS circuitry Note: only available for FR57xx devices

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_PW_H, FRPMM_SVSLE, and HWREGB.

void FRPMM_regOff ( unsigned int  baseAddress)

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

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_PMMREGOFF, FRPMM_PW_H, and HWREGB.

void FRPMM_regOn ( unsigned int  baseAddress)

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

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_PMMREGOFF, FRPMM_PW_H, and HWREGB.

void FRPMM_trigPOR ( unsigned int  baseAddress)

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

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_PMMSWPOR, FRPMM_PW_H, and HWREGB.

void FRPMM_trigBOR ( unsigned int  baseAddress)

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

Parameters:
baseAddressis the base address of the PMM module.

Modified registers are PMMCTL0.

Returns:
NONE

References FRPMM_PMMSWBOR, FRPMM_PW_H, and HWREGB.

void FRPMM_clearInterrupt ( unsigned int  baseAddress,
unsigned int  mask 
)

Clear all interrupt flags for the PMM

Parameters:
baseAddressis the base address of the PMM module.
maskis the mask for specifying the required flag Valid values are FRPMM_PMMBORIFG FRPMM_PMMRSTIFG, FRPMM_PMMPORIFG, FRPMM_SVSLIFG, FRPMM_SVSHIFG, FRPMM_PMMLPM5IFG, FRPMM_ALL

Modified registers are PMMCTL0, PMMIFG.

Returns:
NONE

References FRPMM_PW_H, HWREG, and HWREGB.

unsigned int FRPMM_getInterruptStatus ( unsigned int  baseAddress,
unsigned int  mask 
)

Returns interrupt status

Parameters:
baseAddressis the base address of the PMM module.
maskis the mask for specifying the required flag Valid values are FRPMM_PMMBORIFG FRPMM_PMMRSTIFG, FRPMM_PMMPORIFG, FRPMM_SVSLIFG, FRPMM_SVSHIFG, FRPMM_PMMLPM5IFG,
Returns:
STATUS_SUCCESS (0x01) or STATUS_FAIL (0x00)

References HWREG.

void FRPMM_lockLPM5 ( unsigned int  baseAddress)

Lock I/O pin and other LPMx.5 relevant (e.g. RTC) configurations upon entry/exit to/from LPMx.5. Once power is applied to the device, this bit, once set, can only be cleared by the user or via another power cycle. LPMx.5 configuration remains locked. Pin state is held during LPMx.5 entry and exit.

Parameters:
baseAddressis the base address of the PMM module.
Returns:
NONE

References FRPMM_LOCKLPM5, FRPMM_PW_H, and HWREGB.

void FRPMM_unlockLPM5 ( unsigned int  baseAddress)

LPMx.5 configuration is not locked and defaults to its reset condition.

Parameters:
baseAddressis the base address of the PMM module.
Returns:
NONE

References FRPMM_LOCKLPM5, FRPMM_PW_H, and HWREGB.


Copyright 2012, Texas Instruments Incorporated