Go to the source code of this file.
Defines | |
#define | __MSP430_HAS_REF__ |
#define | REF_VREF1_5V (REFVSEL_0) |
#define | REF_VREF2_0V (REFVSEL_1) |
#define | REF_VREF2_5V (REFVSEL_2) |
#define | REF_NOTBUSY (0x0) |
#define | REF_BUSY (0x1) |
#define | REF_INACTIVE (0x0) |
#define | REF_ACTIVE (0x1) |
#define | REF_STATICMODE (0x0) |
#define | REF_SAMPLEMODE (0x1) |
Functions | |
void | REF_setReferenceVoltage (unsigned int baseAddress, unsigned char referenceVoltageSelect) |
void | REF_disableTempSensor (unsigned int baseAddress) |
void | REF_enableTempSensor (unsigned int baseAddress) |
void | REF_enableReferenceVoltageOutput (unsigned int baseAddress) |
void | REF_disableReferenceVoltageOutput (unsigned int baseAddress) |
void | REF_enableReferenceVoltage (unsigned int baseAddress) |
void | REF_disableReferenceVoltage (unsigned int baseAddress) |
unsigned short | REF_getBandgapMode (unsigned int baseAddress) |
unsigned short | REF_isBandgapActive (unsigned int baseAddress) |
unsigned short | REF_isRefGenBusy (unsigned int baseAddress) |
unsigned short | REF_isRefGen (unsigned int baseAddress) |
#define __MSP430_HAS_REF__ |
#define REF_VREF1_5V (REFVSEL_0) |
#define REF_VREF2_0V (REFVSEL_1) |
#define REF_VREF2_5V (REFVSEL_2) |
Referenced by REF_setReferenceVoltage().
#define REF_NOTBUSY (0x0) |
Referenced by REF_isRefGenBusy().
#define REF_BUSY (0x1) |
Referenced by REF_isRefGenBusy().
#define REF_INACTIVE (0x0) |
Referenced by REF_isBandgapActive(), and REF_isRefGenActive().
#define REF_ACTIVE (0x1) |
Referenced by REF_isBandgapActive(), and REF_isRefGenActive().
#define REF_STATICMODE (0x0) |
Referenced by REF_getBandgapMode().
#define REF_SAMPLEMODE (0x1) |
Referenced by REF_getBandgapMode().
void REF_setReferenceVoltage | ( | unsigned int | baseAddress, |
unsigned char | referenceVoltageSelect | ||
) |
Sets the reference voltage for the voltage generator.
baseAddress | is the base address of the REF module. |
referenceVoltageSelect | is 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. |
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.
References ASSERT, HWREGB, and REF_VREF2_5V.
void REF_disableTempSensor | ( | unsigned int | baseAddress | ) |
Disables the internal temperature sensor to save power consumption.
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 REF_isRefGenBusy() returns REF_ BUSY, this function will have no effect.
Modified bits are REFTCOFF of REFCTL0 register.
References HWREGB.
void REF_enableTempSensor | ( | unsigned int | baseAddress | ) |
Enables the internal temperature sensor.
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 REF_isRefGenBusy() returns REF_ BUSY, this function will have no effect.
Modified bits are REFTCOFF of REFCTL0 register.
References HWREGB.
void REF_enableReferenceVoltageOutput | ( | unsigned int | baseAddress | ) |
Outputs the reference voltage to an output pin.
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 REF_isRefGenBusy() returns REF_BUSY, this function will have no effect.
NOTE: Function not applicable for MSP430FR5xx Family
Modified bits are REFOUT of REFCTL0 register.
References HWREGB.
void REF_disableReferenceVoltageOutput | ( | unsigned int | baseAddress | ) |
Disables the reference voltage as an output to a pin.
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 REF_isRefGenBusy() returns REF_ BUSY, this function will have no effect.
References HWREGB.
void REF_enableReferenceVoltage | ( | unsigned int | baseAddress | ) |
Enables the reference voltage to be used by peripherals.
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 REF_isRefGenBusy() returns REF_ BUSY, this function will have no effect.
Modified bits are REFON of REFCTL0 register.
References HWREGB.
void REF_disableReferenceVoltage | ( | unsigned int | baseAddress | ) |
Disables the reference voltage.
baseAddress | is the base address of the REF module. |
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.
Modified bits are REFON of REFCTL0 register.
References HWREGB.
unsigned short REF_getBandgapMode | ( | unsigned int | baseAddress | ) |
Returns the bandgap mode of the REF module.
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.
References HWREGB, REF_SAMPLEMODE, and REF_STATICMODE.
unsigned short REF_isBandgapActive | ( | unsigned int | baseAddress | ) |
Returns the active status of the bandgap in the REF module.
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.
References HWREGB, REF_ACTIVE, and REF_INACTIVE.
unsigned short REF_isRefGenBusy | ( | unsigned int | baseAddress | ) |
Returns the busy status of the reference generator in the REF module.
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.
References HWREGB, REF_BUSY, and REF_NOTBUSY.
unsigned short REF_isRefGen | ( | unsigned int | baseAddress | ) |