Defines | Functions
ldoPwr.h File Reference

Go to the source code of this file.

Defines

#define __MSP430_HAS_PU__
#define LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT   LDOOFFIE_H
#define LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT   LDOONIE_H
#define LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT   LDOOVLIE_H
#define LDOPWR_LDO_INPUT_VALID   LDOBGVBV
#define LDOPWR_LDO_INPUT_INVALID   0x00
#define LDOPWR_AUTOOFF_ENABLED   OVLAOFF_H
#define LDOPWR_AUTOOFF_DISABLED   0x00
#define LDOPWR_PORTU_PIN_HIGH   PUOUT0
#define LDOPWR_PORTU_PIN_LOW   0x00

Functions

void LDOPWR_unLockConfiguration (unsigned int baseAddress)
void LDOPWR_lockConfiguration (unsigned int baseAddress)
void LDOPWR_enablePort_U_inputs (unsigned int baseAddress)
void LDOPWR_disablePort_U_inputs (unsigned int baseAddress)
void LDOPWR_enablePort_U_outputs (unsigned int baseAddress)
void LDOPWR_disablePort_U_outputs (unsigned int baseAddress)
unsigned char LDOPWR_getPort_U1_inputData (unsigned int baseAddress)
unsigned char LDOPWR_getPort_U0_inputData (unsigned int baseAddress)
unsigned char LDOPWR_getPort_U1_outputData (unsigned int baseAddress)
unsigned char LDOPWR_getPort_U0_outputData (unsigned int baseAddress)
void LDOPWR_enableInterrupt (unsigned int baseAddress, unsigned int mask)
void LDOPWR_disableInterrupt (unsigned int baseAddress, unsigned int mask)
void LDOPWR_enable (unsigned int baseAddress)
void LDOPWR_disable (unsigned int baseAddress)
unsigned char LDOPWR_getInterruptStatus (unsigned int baseAddress, unsigned int mask)
unsigned char LDOPWR_isLDOInputValid (unsigned int baseAddress)
void LDOPWR_enableOverloadAutoOff (unsigned int baseAddress)
void LDOPWR_disableOverloadAutoOff (unsigned int baseAddress)
unsigned char LDOPWR_getOverloadAutoOffStatus (unsigned int baseAddress)
void LDOPWR_clearInterruptStatus (unsigned int baseAddress, unsigned int mask)
void LDOPWR_setPort_U0_outputData (unsigned int baseAddress, unsigned char value)
void LDOPWR_togglePort_U1_outputData (unsigned int baseAddress)
void LDOPWR_togglePort_U0_outputData (unsigned int baseAddress)
void LDOPWR_setPort_U1_outputData (unsigned int baseAddress, unsigned char value)

Define Documentation

#define __MSP430_HAS_PU__
#define LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT   LDOOFFIE_H
#define LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT   LDOONIE_H
#define LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT   LDOOVLIE_H
#define LDOPWR_LDO_INPUT_VALID   LDOBGVBV
#define LDOPWR_LDO_INPUT_INVALID   0x00
#define LDOPWR_AUTOOFF_ENABLED   OVLAOFF_H
#define LDOPWR_AUTOOFF_DISABLED   0x00
#define LDOPWR_PORTU_PIN_HIGH   PUOUT0
#define LDOPWR_PORTU_PIN_LOW   0x00

Function Documentation

void LDOPWR_unLockConfiguration ( unsigned int  baseAddress)

Unlocks the configuration registers and enables write access

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is LDOKEYPID

Returns:
NONE

References HWREG.

void LDOPWR_lockConfiguration ( unsigned int  baseAddress)

Locks the configuration registers and disables write access

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is LDOKEYPID

Returns:
NONE

References HWREG.

void LDOPWR_enablePort_U_inputs ( unsigned int  baseAddress)

Enables Port U inputs

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is PUCTL

Returns:
NONE

References HWREGB.

void LDOPWR_disablePort_U_inputs ( unsigned int  baseAddress)

Disables Port U inputs

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is PUCTL

Returns:
NONE

References HWREGB.

void LDOPWR_enablePort_U_outputs ( unsigned int  baseAddress)

Enables Port U outputs

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is PUCTL

Returns:
NONE

References HWREGB.

void LDOPWR_disablePort_U_outputs ( unsigned int  baseAddress)

Disables Port U inputs

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is PUCTL

Returns:
NONE

References HWREGB.

unsigned char LDOPWR_getPort_U1_inputData ( unsigned int  baseAddress)

Returns PU.1 input data

Parameters:
baseAddressis the base address of the LDO-PWR module.
Returns:
LDOPWR_PORTU_PIN_HIGH or LDOPWR_PORTU_PIN_LOW - PU.1 input data

References HWREGB.

unsigned char LDOPWR_getPort_U0_inputData ( unsigned int  baseAddress)

Returns PU.0 input data

Parameters:
baseAddressis the base address of the LDO-PWR module.
Returns:
LDOPWR_PORTU_PIN_HIGH or LDOPWR_PORTU_PIN_LOW - PU.0 input data

References HWREGB.

unsigned char LDOPWR_getPort_U1_outputData ( unsigned int  baseAddress)

Returns PU.1 output data

Parameters:
baseAddressis the base address of the LDO-PWR module.
Returns:
LDOPWR_PORTU_PIN_HIGH or LDOPWR_PORTU_PIN_LOW - PU.1 output data

References HWREGB.

unsigned char LDOPWR_getPort_U0_outputData ( unsigned int  baseAddress)

Returns PU.0 output data

Parameters:
baseAddressis the base address of the LDO-PWR module.
Returns:
LDOPWR_PORTU_PIN_HIGH or LDOPWR_PORTU_PIN_LOW - PU.0 output data

References HWREGB.

void LDOPWR_enableInterrupt ( unsigned int  baseAddress,
unsigned int  mask 
)

Enables LDO-PWR module interrupts

Parameters:
baseAddressis the base address of the LDO-PWR module.
maskis the logical OR of LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT, LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT or LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT

Modified register is LDOPWRCTL

Returns:
None

References ASSERT, HWREGB, LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT, LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT, and LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT.

void LDOPWR_disableInterrupt ( unsigned int  baseAddress,
unsigned int  mask 
)

Disables LDO-PWR module interrupts

Parameters:
baseAddressis the base address of the LDO-PWR module.
maskis the logical OR of LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT, LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT, LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT

Modified register is LDOPWRCTL

Returns:
None

References ASSERT, HWREGB, LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT, LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT, and LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT.

void LDOPWR_enable ( unsigned int  baseAddress)

Enables LDO-PWR module

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is LDOPWRCTL

Returns:
None

References HWREGB.

void LDOPWR_disable ( unsigned int  baseAddress)

Disables LDO-PWR module

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is LDOPWRCTL

Returns:
None

References HWREGB.

unsigned char LDOPWR_getInterruptStatus ( unsigned int  baseAddress,
unsigned int  mask 
)

Returns the interrupt status of LDO-PWR module interrupts

Parameters:
baseAddressis the base address of the LDO-PWR module.
maskis the logical OR of LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT, LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT or LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT
Returns:
unsigned char - masked interrupt flags

References ASSERT, HWREGB, LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT, LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT, and LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT.

unsigned char LDOPWR_isLDOInputValid ( unsigned int  baseAddress)

Returns if the the LDOI is valid and within bounds

Parameters:
baseAddressis the base address of the LDO-PWR module.
Returns:
unsigned char - Valid values are LDOPWR_LDO_INPUT_VALID LDOPWR_LDO_INPUT_INVALID

References HWREGB.

void LDOPWR_enableOverloadAutoOff ( unsigned int  baseAddress)

Enables the LDO overload auto-off

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is LDOPWRCTL

Returns:
None

References HWREGB.

void LDOPWR_disableOverloadAutoOff ( unsigned int  baseAddress)

Disables the LDO overload auto-off

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is LDOPWRCTL

Returns:
None

References HWREGB.

unsigned char LDOPWR_getOverloadAutoOffStatus ( unsigned int  baseAddress)

Returns if the LDOI overload auto-off is enabled or disabled

Parameters:
baseAddressis the base address of the LDO-PWR module.
Returns:
unsigned char - Valid values are LDOPWR_AUTOOFF_ENABLED LDOPWR_AUTOOFF_DISABLED

References HWREGB.

void LDOPWR_clearInterruptStatus ( unsigned int  baseAddress,
unsigned int  mask 
)

Clears the interrupt status of LDO-PWR module interrupts

Parameters:
baseAddressis the base address of the LDO-PWR module.
maskis the logical OR of LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT, LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT, LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT

Modified register is LDOPWRCTL

Returns:
None

References ASSERT, HWREGB, LDOPWR_LDO_OVERLOAD_INDICATION_INTERRUPT, LDOPWR_LDOI_VOLTAGE_COMING_ON_INTERRUPT, and LDOPWR_LDOI_VOLTAGE_GOING_OFF_INTERRUPT.

void LDOPWR_setPort_U0_outputData ( unsigned int  baseAddress,
unsigned char  value 
)

Sets PU.0 output data

Parameters:
baseAddressis the base address of the LDO-PWR module.
valueValid values are LDOPWR_PORTU_PIN_HIGH LDOPWR_PORTU_PIN_LOW

Modified register is PUCTL

Returns:
None

References HWREGB, and LDOPWR_PORTU_PIN_HIGH.

void LDOPWR_togglePort_U1_outputData ( unsigned int  baseAddress)

Toggles PU.1 output data

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is PUCTL

Returns:
None

References HWREGB.

void LDOPWR_togglePort_U0_outputData ( unsigned int  baseAddress)

Toggles PU.0 output data

Parameters:
baseAddressis the base address of the LDO-PWR module.

Modified register is PUCTL

Returns:
None

References HWREGB.

void LDOPWR_setPort_U1_outputData ( unsigned int  baseAddress,
unsigned char  value 
)

Sets PU.1 output data

Parameters:
baseAddressis the base address of the LDO-PWR module.
value.Valid values are LDOPWR_PORTU_PIN_HIGH LDOPWR_PORTU_PIN_LOW

Modified register is PUCTL

Returns:
None

References HWREGB, and LDOPWR_PORTU_PIN_HIGH.


Copyright 2012, Texas Instruments Incorporated