MSP430 DriverLib for MSP430FR5xx_6xx Devices  2.10.00.09
 All Data Structures Functions Variables Modules Pages
Functions
ref_a

Functions

void Ref_A_setReferenceVoltage (uint16_t baseAddress, uint8_t referenceVoltageSelect)
 Sets the reference voltage for the voltage generator. More...
 
void Ref_A_disableTempSensor (uint16_t baseAddress)
 Disables the internal temperature sensor to save power consumption. More...
 
void Ref_A_enableTempSensor (uint16_t baseAddress)
 Enables the internal temperature sensor. More...
 
void Ref_A_enableReferenceVoltageOutput (uint16_t baseAddress)
 Outputs the reference voltage to an output pin. More...
 
void Ref_A_disableReferenceVoltageOutput (uint16_t baseAddress)
 Disables the reference voltage as an output to a pin. More...
 
void Ref_A_enableReferenceVoltage (uint16_t baseAddress)
 Enables the reference voltage to be used by peripherals. More...
 
void Ref_A_disableReferenceVoltage (uint16_t baseAddress)
 Disables the reference voltage. More...
 
uint16_t Ref_A_getBandgapMode (uint16_t baseAddress)
 Returns the bandgap mode of the Ref_A module. More...
 
bool Ref_A_isBandgapActive (uint16_t baseAddress)
 Returns the active status of the bandgap in the Ref_A module. More...
 
uint16_t Ref_A_isRefGenBusy (uint16_t baseAddress)
 Returns the busy status of the reference generator in the Ref_A module. More...
 
bool Ref_A_isRefGenActive (uint16_t baseAddress)
 Returns the active status of the reference generator in the Ref_A module. More...
 
bool Ref_A_isBufferedBandgapVoltageReady (uint16_t baseAddress)
 Returns the busy status of the reference generator in the Ref_A module. More...
 
bool Ref_A_isVariableReferenceVoltageOutputReady (uint16_t baseAddress)
 Returns the busy status of the variable reference voltage in the Ref_A module. More...
 
void Ref_A_setReferenceVoltageOneTimeTrigger (uint16_t baseAddress)
 Enables the one-time trigger of the reference voltage. More...
 
void Ref_A_setBufferedBandgapVoltageOneTimeTrigger (uint16_t baseAddress)
 Enables the one-time trigger of the buffered bandgap voltage. More...
 

Detailed Description

Function Documentation

void Ref_A_disableReferenceVoltage ( uint16_t  baseAddress)

Disables the reference voltage.

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

Parameters
baseAddressis the base address of the REF_A module.

Modified bits are REFON of REFCTL0 register.

Returns
None
void Ref_A_disableReferenceVoltageOutput ( uint16_t  baseAddress)

Disables the reference voltage as an output to a pin.

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

Parameters
baseAddressis the base address of the REF_A module.

Modified bits are REFOUT of REFCTL0 register.

Returns
None
void Ref_A_disableTempSensor ( uint16_t  baseAddress)

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 enabled by default. Please note, that giving ADC12 module control over the Ref_A module, the state of the temperature sensor is dependent on the controls of the ADC12 module. Please note, if the Ref_A_isRefGenBusy() returns Ref_A_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF_A module.

Modified bits are REFTCOFF of REFCTL0 register.

Returns
None
void Ref_A_enableReferenceVoltage ( uint16_t  baseAddress)

Enables the reference voltage to be used by peripherals.

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_A module, the state of the reference voltage is dependent on the controls of the ADC12 module. Please note, if the Ref_A_isRefGenBusy() returns Ref_A_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF_A module.

Modified bits are REFON of REFCTL0 register.

Returns
None
void Ref_A_enableReferenceVoltageOutput ( uint16_t  baseAddress)

Outputs the reference voltage to an output pin.

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_A 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 Ref_A_isRefGenBusy() returns Ref_A_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF_A module.

Modified bits are REFOUT of REFCTL0 register.

Returns
None
void Ref_A_enableTempSensor ( uint16_t  baseAddress)

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 enabled by default. Please note, if the Ref_A_isRefGenBusy() returns Ref_A_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF_A module.

Modified bits are REFTCOFF of REFCTL0 register.

Returns
None
uint16_t Ref_A_getBandgapMode ( uint16_t  baseAddress)

Returns the bandgap mode of the Ref_A module.

This function is used to return the bandgap mode of the Ref_A 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.

Parameters
baseAddressis the base address of the REF_A module.
Returns
One of the following:
  • Ref_A_STATICMODE if the bandgap is operating in static mode
  • Ref_A_SAMPLEMODE if the bandgap is operating in sample mode
    indicating the bandgap mode of the module
bool Ref_A_isBandgapActive ( uint16_t  baseAddress)

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

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

Parameters
baseAddressis the base address of the REF_A module.
Returns
One of the following:
  • Ref_A_ACTIVE if active
  • Ref_A_INACTIVE if not active
    indicating the bandgap active status of the module
bool Ref_A_isBufferedBandgapVoltageReady ( uint16_t  baseAddress)

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

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

Parameters
baseAddressis the base address of the REF_A module.
Returns
One of the following:
  • Ref_A_NOTREADY if NOT ready to be used
  • Ref_A_READY if ready to be used
    indicating the the busy status of the reference generator in the module
bool Ref_A_isRefGenActive ( uint16_t  baseAddress)

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

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

Parameters
baseAddressis the base address of the REF_A module.
Returns
One of the following:
  • Ref_A_ACTIVE if active
  • Ref_A_INACTIVE if not active
    indicating the reference generator active status of the module
uint16_t Ref_A_isRefGenBusy ( uint16_t  baseAddress)

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

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

Parameters
baseAddressis the base address of the REF_A module.
Returns
One of the following:
  • Ref_A_NOTBUSY if the reference generator is not being used
  • Ref_A_BUSY if the reference generator is being used, disallowing changes to be made to the Ref_A module controls
    indicating the reference generator busy status of the module
bool Ref_A_isVariableReferenceVoltageOutputReady ( uint16_t  baseAddress)

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

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

Parameters
baseAddressis the base address of the REF_A module.
Returns
One of the following:
  • Ref_A_NOTREADY if NOT ready to be used
  • Ref_A_READY if ready to be used
    indicating the the busy status of the variable reference voltage in the module
void Ref_A_setBufferedBandgapVoltageOneTimeTrigger ( uint16_t  baseAddress)

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

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

Parameters
baseAddressis the base address of the REF_A module.

Modified bits are REFBGOT of REFCTL0 register.

Returns
None
void Ref_A_setReferenceVoltage ( uint16_t  baseAddress,
uint8_t  referenceVoltageSelect 
)

Sets the reference voltage for the voltage generator.

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_A module is in control. Please note, if the Ref_A_isRefGenBusy() returns Ref_A_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF_A module.
referenceVoltageSelectis the desired voltage to generate for a reference voltage. Valid values are:
  • REF_A_VREF1_2V [Default]
  • REF_A_VREF2_0V
  • REF_A_VREF2_5V
    Modified bits are REFVSEL of REFCTL0 register.
Returns
None
void Ref_A_setReferenceVoltageOneTimeTrigger ( uint16_t  baseAddress)

Enables the one-time trigger of the reference voltage.

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

Parameters
baseAddressis the base address of the REF_A module.

Modified bits are REFGENOT of REFCTL0 register.

Returns
None
Copyright 2015, Texas Instruments Incorporated