MSP430 DriverLib for MSP430F5xx_6xx Devices  2.91.13.01
ref

Functions

void Ref_setReferenceVoltage (uint16_t baseAddress, uint8_t referenceVoltageSelect)
 Sets the reference voltage for the voltage generator. More...
 
void Ref_disableTempSensor (uint16_t baseAddress)
 Disables the internal temperature sensor to save power consumption. More...
 
void Ref_enableTempSensor (uint16_t baseAddress)
 Enables the internal temperature sensor. More...
 
void Ref_enableReferenceVoltageOutput (uint16_t baseAddress)
 Outputs the reference voltage to an output pin. More...
 
void Ref_disableReferenceVoltageOutput (uint16_t baseAddress)
 Disables the reference voltage as an output to a pin. More...
 
void Ref_enableReferenceVoltage (uint16_t baseAddress)
 Enables the reference voltage to be used by peripherals. More...
 
void Ref_disableReferenceVoltage (uint16_t baseAddress)
 Disables the reference voltage. More...
 
uint16_t Ref_getBandgapMode (uint16_t baseAddress)
 Returns the bandgap mode of the Ref module. More...
 
bool Ref_isBandgapActive (uint16_t baseAddress)
 Returns the active status of the bandgap in the Ref module. More...
 
uint16_t Ref_isRefGenBusy (uint16_t baseAddress)
 Returns the busy status of the reference generator in the Ref module. More...
 
bool Ref_isRefGenActive (uint16_t baseAddress)
 Returns the active status of the reference generator in the Ref module. More...
 

Detailed Description

Function Documentation

§ Ref_disableReferenceVoltage()

void Ref_disableReferenceVoltage ( uint16_t  baseAddress)

Disables the reference voltage.

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

Parameters
baseAddressis the base address of the REF module.

Modified bits are REFON of REFCTL0 register.

Returns
None

§ Ref_disableReferenceVoltageOutput()

void Ref_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_isRefGenBusy() returns Ref_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF module.

Modified bits are REFOUT of REFCTL0 register.

Returns
None

§ Ref_disableTempSensor()

void Ref_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 module, the state of the temperature sensor is dependent on the controls of the ADC12 module. Please note, if the Ref_isRefGenBusy() returns Ref_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF module.

Modified bits are REFTCOFF of REFCTL0 register.

Returns
None

§ Ref_enableReferenceVoltage()

void Ref_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 module, the state of the reference voltage is dependent on the controls of the ADC12 module. Please note, ADC10_A does not support the reference request. If the Ref_isRefGenBusy() returns Ref_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF module.

Modified bits are REFON of REFCTL0 register.

Returns
None

§ Ref_enableReferenceVoltageOutput()

void Ref_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 module, the state of the reference voltage as an output to a pin is dependent on the controls of the ADC12 module. If ADC12_A reference burst is disabled or DAC12_A is enabled, this output is available continuously. If ADC12_A reference burst is enabled, this output is available only during an ADC12_A conversion. For devices with CTSD16, Ref_enableReferenceVoltage() needs to be invoked to get VREFBG available continuously. Otherwise, VREFBG is only available externally when a module requests it. Please note, if the Ref_isRefGenBusy() returns Ref_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF module.

Modified bits are REFOUT of REFCTL0 register.

Returns
None

§ Ref_enableTempSensor()

void Ref_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_isRefGenBusy() returns Ref_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF module.

Modified bits are REFTCOFF of REFCTL0 register.

Returns
None

§ Ref_getBandgapMode()

uint16_t Ref_getBandgapMode ( uint16_t  baseAddress)

Returns the bandgap mode 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.

Parameters
baseAddressis the base address of the REF module.
Returns
One of the following:
  • REF_STATICMODE if the bandgap is operating in static mode
  • REF_SAMPLEMODE if the bandgap is operating in sample mode
    indicating the bandgap mode of the module

§ Ref_isBandgapActive()

bool Ref_isBandgapActive ( uint16_t  baseAddress)

Returns the active status of the bandgap in 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.

Parameters
baseAddressis the base address of the REF module.
Returns
One of the following:
  • REF_ACTIVE if active
  • REF_INACTIVE if not active
    indicating the bandgap active status of the module

§ Ref_isRefGenActive()

bool Ref_isRefGenActive ( uint16_t  baseAddress)

Returns the active status of the reference generator in 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.

Parameters
baseAddressis the base address of the REF module.
Returns
One of the following:
  • REF_ACTIVE if active
  • REF_INACTIVE if not active
    indicating the reference generator active status of the module

§ Ref_isRefGenBusy()

uint16_t Ref_isRefGenBusy ( uint16_t  baseAddress)

Returns the busy status of the reference generator in 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.

Parameters
baseAddressis the base address of the REF module.
Returns
One of the following:
  • REF_NOTBUSY if the reference generator is not being used
  • REF_BUSY if the reference generator is being used, disallowing changes to be made to the Ref module controls
    indicating the reference generator busy status of the module

§ Ref_setReferenceVoltage()

void Ref_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 module is in control. Please note, if the Ref_isRefGenBusy() returns Ref_BUSY, this function will have no effect.

Parameters
baseAddressis the base address of the REF module.
referenceVoltageSelectis the desired voltage to generate for a reference voltage. Valid values are:
  • REF_VREF1_5V [Default]
  • REF_VREF2_0V
  • REF_VREF2_5V
    Modified bits are REFVSEL of REFCTL0 register.
Returns
None

Copyright 2020, Texas Instruments Incorporated