#include "driverlib/5xx_6xx/compd.h"
#include "inc/hw_types.h"
#include "deprecated/CCS/msp430xgeneric.h"
#include "driverlib/5xx_6xx/debug.h"
Functions | |
unsigned short | COMPD_init (unsigned int baseAddress, unsigned char positiveTerminalInput, unsigned char negativeTerminalInput, unsigned char outputFilterEnableAndDelayLevel, unsigned short invertedOutputPolarity) |
void | COMPD_setReferenceVoltage (unsigned int baseAddress, unsigned int supplyVoltageReferenceBase, unsigned int lowerLimitSupplyVoltageFractionOf32, unsigned int upperLimitSupplyVoltageFractionOf32) |
void | COMPD_enableInterrupt (unsigned int baseAddress, unsigned int interruptMask) |
void | COMPD_disableInterrupt (unsigned int baseAddress, unsigned int interruptMask) |
void | COMPD_clearInterrupt (unsigned int baseAddress, unsigned int interruptFlagMask) |
unsigned char | COMPD_getInterruptStatus (unsigned int baseAddress, unsigned int interruptFlagMask) |
void | COMPD_interruptSetEdgeDirection (unsigned int baseAddress, unsigned short edgeDirection) |
void | COMPD_interruptToggleEdgeDirection (unsigned int baseAddress) |
void | COMPD_enable (unsigned int baseAddress) |
void | COMPD_disable (unsigned int baseAddress) |
void | COMPD_shortInputs (unsigned int baseAddress) |
void | COMPD_unshortInputs (unsigned int baseAddress) |
void | COMPD_disableInputBuffer (unsigned int baseAddress, unsigned char inputPort) |
void | COMPD_enableInputBuffer (unsigned int baseAddress, unsigned char inputPort) |
void | COMPD_IOSwap (unsigned int baseAddress) |
unsigned short | COMPD_outputValue (unsigned int baseAddress) |
unsigned short COMPD_init | ( | unsigned int | baseAddress, |
unsigned char | positiveTerminalInput, | ||
unsigned char | negativeTerminalInput, | ||
unsigned char | outputFilterEnableAndDelayLevel, | ||
unsigned short | invertedOutputPolarity | ||
) |
Initializes the Comparator Module.
baseAddress | is the base address of the Comparator module. |
positiveTerminalInput | selects the input to the positive terminal. Valid values are COMPD_INPUT0 [Default] COMPD_INPUT1 COMPD_INPUT2 COMPD_INPUT3 COMPD_INPUT4 COMPD_INPUT5 COMPD_INPUT6 COMPD_INPUT7 COMPD_INPUT8 COMPD_INPUT9 COMPD_INPUT10 COMPD_INPUT11 COMPD_INPUT12 COMPD_INPUT13 COMPD_INPUT14 COMPD_INPUT15 COMPD_VREF Modified bits are CDIPSEL and CDIPEN of CDCTL0 register, CDRSEL of CDCTL2 register, and CDPDx of CDCTL3 register. |
negativeTerminalInput | selects the input to the negative terminal. Valid values are COMPD_INPUT0 [Default] COMPD_INPUT1 COMPD_INPUT2 COMPD_INPUT3 COMPD_INPUT4 COMPD_INPUT5 COMPD_INPUT6 COMPD_INPUT7 COMPD_INPUT8 COMPD_INPUT9 COMPD_INPUT10 COMPD_INPUT11 COMPD_INPUT12 COMPD_INPUT13 COMPD_INPUT14 COMPD_INPUT15 COMPD_VREF Modified bits are CDIMSEL and CDIMEN of CDCTL0 register, CDRSEL of CDCTL2 register, and CDPDx of CDCTL3 register. |
outputFilterEnableAndDelayLevel | controls the output filter delay state, which is either off or enabled with a specified delay level. Valid values are COMPD_FILTEROUTPUT_OFF [Default] COMPD_FILTEROUTPUT_DLYLVL1 COMPD_FILTEROUTPUT_DLYLVL2 COMPD_FILTEROUTPUT_DLYLVL3 COMPD_FILTEROUTPUT_DLYLVL4 This parameter is device specific and delay levels should be found in the device's datasheet. Modified bits are CDF and CDFDLY of CDCTL1 register. |
invertedOutput | controls if the output will be inverted or not Valid values are COMPD_NORMALOUTPUTPOLARITY - indicates the output should be normal. [Default] COMPD_INVERTEDOUTPUTPOLARITY - the output should be inverted. Modified bits are CDOUTPOL of CDCTL1 register. |
Upon successful initialization of the Comparator module, this function will have reset all necessary register bits and set the given options in the registers. To actually use the comparator module, the COMPD_enable() function must be explicitly called before use. If a Reference Voltage is set to a terminal, the Voltage should be set using the setReferenceVoltage() function.
References ASSERT, COMPD_FILTEROUTPUT_DLYLVL4, COMPD_VREF, HWREG, and STATUS_SUCCESS.
void COMPD_setReferenceVoltage | ( | unsigned int | baseAddress, |
unsigned int | supplyVoltageReferenceBase, | ||
unsigned int | lowerLimitSupplyVoltageFractionOf32, | ||
unsigned int | upperLimitSupplyVoltageFractionOf32 | ||
) |
Generates a Reference Voltage to the terminal selected during initialization.
baseAddress | is the base address of the Comparator module. |
supplyVoltageReferenceBase | decides the source and max amount of Voltage that can be used as a reference. Valid values are COMPD_REFERENCE_AMPLIFIER_DISABLED COMPD_VREFBASE1_5V COMPD_VREFBASE2_0V COMPD_VREFBASE2_5V Modified bits are CDREFL of CDCTL2 register. |
upperLimitSupplyVoltageFractionOf32 | is the numerator of the equation to generate the reference voltage for the upper limit reference voltage. Modified bits are CDREF1 of CDCTL2 register. |
lowerLimitSupplyVoltageFractionOf32 | is the numerator of the equation to generate the reference voltage for the lower limit reference voltage. Modified bits are CDREF0 of CDCTL2 register. |
Use this function to generate a voltage to serve as a reference to the terminal selected at initialization. The voltage is determined by the equation: Vbase * (Numerator / 32). If the upper and lower limit voltage numerators are equal, then a static reference is defined, whereas they are different then a hysteresis effect is generated.
References ASSERT, COMPD_VREFBASE2_5V, COMPD_VREFBASE_VCC, and HWREG.
void COMPD_enableInterrupt | ( | unsigned int | baseAddress, |
unsigned int | interruptMask | ||
) |
Enables selected Comparator interrupt sources.
baseAddress | is the base address of the Comparator module. |
mask | is the bit mask of the interrupt sources to be enabled. Mask value is the logical OR of any of the following COMPD_INTERRUPT_ENABLE - Output interrupt enable COMPD_INTERRUPT_ENABLE_INVERTED_POLARITY - Output interrupt enable inverted polarity |
Enables the indicated Comparator interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor. The default trigger for the non-inverted interrupt is a rising edge of the output, this can be changed with the interruptSetEdgeDirection() function.
References HWREG.
void COMPD_disableInterrupt | ( | unsigned int | baseAddress, |
unsigned int | interruptMask | ||
) |
Disables selected Comparator interrupt sources.
baseAddress | is the base address of the Comparator module. |
mask | is the bit mask of the interrupt sources to be disabled. Mask value is the logical OR of any of the following COMPD_INTERRUPT_ENABLE - Output interrupt enable COMPD_INTERRUPT_ENABLE_INVERTED_POLARITY - Output interrupt enable inverted polarity |
Disables the indicated Comparator interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.
References HWREG.
void COMPD_clearInterrupt | ( | unsigned int | baseAddress, |
unsigned int | interruptFlagMask | ||
) |
Clears Comparator interrupt flags.
baseAddress | is the base address of the Comparator module. |
mask | is a bit mask of the interrupt sources to be cleared. Mask value is the logical OR of any of the following COMPD_INTERRUPT_FLAG - Output interrupt flag COMPD_INTERRUPT_FLAG_INVERTED_POLARITY - Output interrupt flag inverted polarity |
The Comparator interrupt source is cleared, so that it no longer asserts. The highest interrupt flag is automatically cleared when an interrupt vector generator is used.
References HWREG.
unsigned char COMPD_getInterruptStatus | ( | unsigned int | baseAddress, |
unsigned int | interruptFlagMask | ||
) |
Gets the current Comparator interrupt status.
baseAddress | is the base address of the Comparator module. |
mask | is the masked interrupt flag status to be returned. Mask value is the logical OR of any of the following COMPD_INTERRUPT_FLAG - Output interrupt flag COMPD_INTERRUPT_FLAG_INVERTED_POLARITY - Output interrupt flag inverted polarity |
This returns the interrupt status for the Comparator module based on which flag is passed.
References HWREG.
void COMPD_interruptSetEdgeDirection | ( | unsigned int | baseAddress, |
unsigned short | edgeDirection | ||
) |
Explicitly sets the edge direction that would trigger an interrupt.
baseAddress | is the base address of the Comparator module. |
edgeDirection | determines which direction the edge would have to go to generate an interrupt based on the non-inverted interrupt flag. Valid values are COMPD_FALLINGEDGE - sets the bit to generate an interrupt when the output of the comparator falls from HIGH to LOW if the normal interrupt bit is set(and LOW to HIGH if the inverted interrupt enable bit is set). [Default] COMPD_RISINGEDGE - sets the bit to generate an interrupt when the output of the comparator rises from LOW to HIGH if the normal interrupt bit is set(and HIGH to LOW if the inverted interrupt enable bit is set). Modified bits are CDIES of CDCTL1 register. |
This function will set which direction the output will have to go, whether rising or falling, to generate an interrupt based on a non-inverted interrupt.
References ASSERT, COMPD_FALLINGEDGE, COMPD_RISINGEDGE, and HWREG.
void COMPD_interruptToggleEdgeDirection | ( | unsigned int | baseAddress | ) |
Toggles the edge direction that would trigger an interrupt.
baseAddress | is the base address of the Comparator module. |
This function will toggle which direction the output will have to go, whether rising or falling, to generate an interrupt based on a non-inverted interrupt. If the direction was rising, it is now falling, if it was falling, it is now rising.
Modified bits are CDIES of CDCTL1 register.
References HWREG.
void COMPD_enable | ( | unsigned int | baseAddress | ) |
Turns on the Comparator module.
baseAddress | is the base address of the Comparator module. |
This function sets the bit that enables the operation of the Comparator module.
References HWREG.
void COMPD_disable | ( | unsigned int | baseAddress | ) |
Turns off the Comparator module.
baseAddress | is the base address of the Comparator module. |
This function clears the CDON bit disabling the operation of the Comparator module, saving from excess power consumption.
Modified bits are CDON of CDCTL1 register.
References HWREG.
void COMPD_shortInputs | ( | unsigned int | baseAddress | ) |
Shorts the two input pins chosen during initialization.
baseAddress | is the base address of the Comparator module. |
This function sets the bit that shorts the devices attached to the input pins chosen from the initialization of the comparator.
Modified bits are CDSHORT of CDCTL1 register.
References HWREG.
void COMPD_unshortInputs | ( | unsigned int | baseAddress | ) |
Disables the short of the two input pins chosen during initialization.
baseAddress | is the base address of the Comparator module. |
This function clears the bit that shorts the devices attached to the input pins chosen from the initialization of the comparator.
Modified bits are CDSHORT of CDCTL1 register.
References HWREG.
void COMPD_disableInputBuffer | ( | unsigned int | baseAddress, |
unsigned char | inputPort | ||
) |
Disables the input buffer of the selected input port to effectively allow for analog signals.
baseAddress | is the base address of the Comparator module. |
inputPort | is the port in which the input buffer will be disabled. Valid values are COMPD_INPUT0 [Default] COMPD_INPUT1 COMPD_INPUT2 COMPD_INPUT3 COMPD_INPUT4 COMPD_INPUT5 COMPD_INPUT6 COMPD_INPUT7 COMPD_INPUT8 COMPD_INPUT9 COMPD_INPUT10 COMPD_INPUT11 COMPD_INPUT12 COMPD_INPUT13 COMPD_INPUT14 COMPD_INPUT15 COMPD_VREF Modified bits are CDPDx of CDCTL3 register. |
This function sets the bit to disable the buffer for the specified input port to allow for analog signals from any of the comparator input pins. This bit is automatically set when the input is initialized to be used with the comparator module. This function should be used whenever an analog input is connected to one of these pins to prevent parasitic voltage from causing unexpected results.
References HWREG.
void COMPD_enableInputBuffer | ( | unsigned int | baseAddress, |
unsigned char | inputPort | ||
) |
Enables the input buffer of the selected input port to allow for digital signals.
baseAddress | is the base address of the Comparator module. |
inputPort | is the port in which the input buffer will be enabled. Valid values are COMPD_INPUT0 [Default] COMPD_INPUT1 COMPD_INPUT2 COMPD_INPUT3 COMPD_INPUT4 COMPD_INPUT5 COMPD_INPUT6 COMPD_INPUT7 COMPD_INPUT8 COMPD_INPUT9 COMPD_INPUT10 COMPD_INPUT11 COMPD_INPUT12 COMPD_INPUT13 COMPD_INPUT14 COMPD_INPUT15 COMPD_VREF Modified bits are CDPDx of CDCTL3 register. |
This function clears the bit to enable the buffer for the specified input port to allow for digital signals from any of the comparator input pins. This should not be reset if there is an analog signal connected to the specified input pin to prevent from unexpected results.
References HWREG.
void COMPD_IOSwap | ( | unsigned int | baseAddress | ) |
Toggles the bit that swaps which terminals the inputs go to, while also inverting the output of the comparator.
baseAddress | is the base address of the Comparator module. |
This function toggles the bit that controls which input goes to which terminal. After initialization, this bit is set to 0, after toggling it once the inputs are routed to the opposite terminal and the output is inverted.
Modified bits are CDEX of CDCTL1 register.
References HWREG.
unsigned short COMPD_outputValue | ( | unsigned int | baseAddress | ) |
Returns the output value of the Comparator module.
baseAddress | is the base address of the Comparator module. |
Returns the output value of the Comparator module.
References COMPD_HIGH, COMPD_LOW, and HWREG.