refa.c File Reference

#include "inc/hw_types.h"
#include "driverlib/5xx_6xx/debug.h"
#include "driverlib/5xx_6xx/refa.h"
#include "deprecated/CCS/msp430xgeneric.h"

Functions
void	REFA_setReferenceVoltage (unsigned int baseAddress, unsigned char referenceVoltageSelect)
void	REFA_disableTempSensor (unsigned int baseAddress)
void	REFA_enableTempSensor (unsigned int baseAddress)
void	REFA_enableReferenceVoltageOutput (unsigned int baseAddress)
void	REFA_disableReferenceVoltageOutput (unsigned int baseAddress)
void	REFA_enableReferenceVoltage (unsigned int baseAddress)
void	REFA_disableReferenceVoltage (unsigned int baseAddress)
unsigned short	REFA_getBandgapMode (unsigned int baseAddress)
unsigned short	REFA_isBandgapActive (unsigned int baseAddress)
unsigned short	REFA_isRefGenBusy (unsigned int baseAddress)
unsigned short	REFA_isRefGenActive (unsigned int baseAddress)
unsigned short	REFA_getBufferedBandgapVoltageStatus (unsigned int baseAddress)
unsigned short	REFA_getVariableReferenceVoltageStatus (unsigned int baseAddress)
void	REFA_setReferenceVoltageOneTimeTrigger (unsigned int baseAddress)
void	REFA_setBufferedBandgapVoltageOneTimeTrigger (unsigned int baseAddress)

---

Function Documentation

void REFA_setReferenceVoltage	(	unsigned int	baseAddress,
		unsigned char	referenceVoltageSelect
	)

Sets the reference voltage for the voltage generator.

Parameters:

baseAddress	is the base address of the REF module.
referenceVoltageSelect	is the desired voltage to generate for a reference voltage. Valid values are REFA_VREF1_2V [Default] REFA_VREF2_0V REFA_VREF2_5V Modified bits are REFVSEL of REFCTL0 register.

This function sets the reference voltage generated by the voltage generator to be used by other peripherals. This reference voltage will only be valid while the REF module is in control. Please note, if the REFA_isRefGenBusy() returns REFA_ BUSY, this function will have no effect.

Returns:

NONE

References ASSERT, HWREGB, and REFA_VREF2_5V.

void REFA_disableTempSensor

(

unsigned int

baseAddress

)

Disables the internal temperature sensor to save power consumption.

Parameters:

baseAddress

is the base address of the REF module.

This function is used to turn off the internal temperature sensor to save on power consumption. The temperature sensor is enabled by default. Please note, that giving ADC12 module control over the REF module, the state of the temperature sensor is dependent on the controls of the ADC12 module. Please note, if the REFA_isRefGenBusy() returns REFA_ BUSY, this function will have no effect.

Modified bits are REFTCOFF of REFCTL0 register.

Returns:

NONE

References HWREGB.

void REFA_enableTempSensor

(

unsigned int

baseAddress

)

Enables the internal temperature sensor.

Parameters:

baseAddress

is the base address of the REF module.

This function is used to turn on the internal temperature sensor to use by other peripherals. The temperature sensor is enabled by default. Please note, if the REFA_isRefGenBusy() returns REFA_ BUSY, this function will have no effect.

Modified bits are REFTCOFF of REFCTL0 register.

Returns:

NONE

References HWREGB.

void REFA_enableReferenceVoltageOutput

(

unsigned int

baseAddress

)

Outputs the reference voltage to an output pin.

Parameters:

baseAddress

is the base address of the REF module.

This function is used to output the reference voltage being generated to an output pin. Please note, the output pin is device specific. Please note, that giving ADC12 module control over the REF module, the state of the reference voltage as an output to a pin is dependent on the controls of the ADC12 module. Please note, if the REFA_isRefGenBusy() returns REFA_BUSY, this function will have no effect.

NOTE: Function not applicable for MSP430FR5xx Family

Modified bits are REFOUT of REFCTL0 register.

Returns:

NONE

References HWREGB.

void REFA_disableReferenceVoltageOutput

(

unsigned int

baseAddress

)

Disables the reference voltage as an output to a pin.

Parameters:

baseAddress

is the base address of the REF module.

This function is used to disables the reference voltage being generated to be given to an output pin. Please note, if the REFA_isRefGenBusy() returns REFA_ BUSY, this function will have no effect.

Modified bits are REFOUT of REFCTL0 register.

Returns:

NONE

References HWREGB.

void REFA_enableReferenceVoltage

(

unsigned int

baseAddress

)

Enables the reference voltage to be used by peripherals.

Parameters:

baseAddress

is the base address of the REF module.

This function is used to enable the generated reference voltage to be used other peripherals or by an output pin, if enabled. Please note, that giving ADC12 module control over the REF module, the state of the reference voltage is dependent on the controls of the ADC12 module. Please note, if the REFA_isRefGenBusy() returns REFA_ BUSY, this function will have no effect.

Modified bits are REFON of REFCTL0 register.

Returns:

NONE

References HWREGB.

void REFA_disableReferenceVoltage

(

unsigned int

baseAddress

)

Disables the reference voltage.

Parameters:

baseAddress

is the base address of the REF module.

This function is used to disable the generated reference voltage. Please note, if the REFA_isRefGenBusy() returns REFA_ BUSY, this function will have no effect.

Modified bits are REFON of REFCTL0 register.

Returns:

NONE

References HWREGB.

unsigned short REFA_getBandgapMode

(

unsigned int

baseAddress

)

Returns the bandgap mode of the REF module.

Parameters:

baseAddress

is the base address of the REF module.

This function is used to return the bandgap mode of the REF 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 REF module: REFA_STATICMODE if the bandgap is operating in static mode REFA_SAMPLEMODE if the bandgap is operating in sample mode

References HWREGB, REFA_SAMPLEMODE, and REFA_STATICMODE.

unsigned short REFA_isBandgapActive

(

unsigned int

baseAddress

)

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

Parameters:

baseAddress

is the base address of the REF module.

This function is used to return the active status of the bandgap in the REF 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 REF module: REFA_INACTIVE if the bandgap is not being used at the time of query REFA_ACTIVE if the bandgap is being used at the time of query

References HWREGB, REFA_ACTIVE, and REFA_INACTIVE.

unsigned short REFA_isRefGenBusy

(

unsigned int

baseAddress

)

Returns the busy status of the reference generator in the REF module.

Parameters:

baseAddress

is the base address of the REF module.

This function is used to return the busy status of the reference generator in the REF module. If the ref. generator is in use by a peripheral, then the status will be seen as busy.

Returns:

The reference generator busy status of the REF module: REFA_NOTBUSY if the reference generator is not being used REFA_BUSY if the reference generator is being used, disallowing any changes to be made to the REF module controls

References HWREGB, REFA_BUSY, and REFA_NOTBUSY.

unsigned short REFA_isRefGenActive

(

unsigned int

baseAddress

)

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

Parameters:

baseAddress

is the base address of the REF module.

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

Returns:

The reference generator active status of the REF module: REFA_INACTIVE if the ref. generator is off and not operating REFA_ACTIVE if the ref. generator is on and ready to be used

References HWREGB, REFA_ACTIVE, and REFA_INACTIVE.

unsigned short REFA_getBufferedBandgapVoltageStatus

(

unsigned int

baseAddress

)

Returns the busy status of the reference generator in the REF module.

Parameters:

baseAddress

is the base address of the REF module.

This function is used to return the buys status of the buffered bandgap voltage in the REF module. If the ref. generator is on and ready to use, then the status will be seen as active.

Returns:

The reference generator active status of the REF module: REFA_NOTREADY if buffered bandgap voltage is NOT ready to be used REFA_READY if buffered bandgap voltage ready to be used

References HWREGB, REFA_NOTREADY, and REFA_READY.

unsigned short REFA_getVariableReferenceVoltageStatus

(

unsigned int

baseAddress

)

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

Parameters:

baseAddress

is the base address of the REF module.

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

Returns:

The reference generator active status of the REF module: REFA_NOTREADY if variable reference voltage is NOT ready to be used REFA_READY if variable reference voltage ready to be used

References HWREGB, REFA_NOTREADY, and REFA_READY.

void REFA_setReferenceVoltageOneTimeTrigger

(

unsigned int

baseAddress

)

Enables the one-time trigger of the reference voltage.

Parameters:

baseAddress

is the base address of the REF module.

Triggers the one-time generation of the variable reference voltage. Once the reference voltage request is set, this bit is cleared by hardware

Modified bits are REFGENOT of REFCTL0 register.

Returns:

NONE

References HWREGB.

void REFA_setBufferedBandgapVoltageOneTimeTrigger

(

unsigned int

baseAddress

)

Enables the one-time trigger of the buffered bandgap voltage.

Parameters:

baseAddress

is the base address of the REF module.

Triggers the one-time generation of the buffered bandgap voltage. Once the buffered bandgap voltage request is set, this bit is cleared by hardware

Modified bits are REFBGOT of REFCTL0 register.

Returns:

NONE

References HWREGB.