Contains public interface to various functions related to the analog-to-digital converter (ADC) object. More...

#include "sw/drivers/cpu/src/32b/f28x/f2806x/cpu.h"
#include "sw/modules/types/src/types.h"

Data Structures
struct	_ADC_Obj_
	Defines the analog-to-digital converter (ADC) object. More...

Macros
#define	ADC_BASE_ADDR (0x00000B00)
	Defines the base address of the analog-to-digital converter (ADC) registers. More...

#define	ADC_DELAY_usec 10000L
	Defines the ADC delay for part of the ADC initialization. More...

#define	ADC_numBits 12
	Defines the number of ADC bits. More...

#define	ADC_dataBias (1 << (ADC_numBits - 1))
	Defines the bias value corresponding to a voltage bias of 1.65V on the input data (3.3V input, 12 bit ADC) More...

#define	ADC_ADCCTL1_TEMPCONV_BITS (1 << 0)
	Defines the location of the TEMPCONV bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_VREFLOCONV_BITS (1 << 1)
	Defines the location of the VREFLOCONV bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_INTPULSEPOS_BITS (1 << 2)
	Defines the location of the INTPULSEPOS bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_ADCREFSEL_BITS (1 << 3)
	Defines the location of the ADCREFSEL bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_ADCREFPWD_BITS (1 << 5)
	Defines the location of the ADCREFPWD bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_ADCBGPWD_BITS (1 << 6)
	Defines the location of the ADCBGPWD bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_ADCPWDN_BITS (1 << 7)
	Defines the location of the ADCPWDN bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_ADCBSYCHAN_BITS (31 << 8)
	Defines the location of the ADCBSYCHAN bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_ADCBSY_BITS (1 << 13)
	Defines the location of the ADCBSY bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_ADCENABLE_BITS (1 << 14)
	Defines the location of the ADCENABLE bits in the ADCTL1 register. More...

#define	ADC_ADCCTL1_RESET_BITS (1 << 15)
	Defines the location of the RESET bits in the ADCTL1 register. More...

#define	ADC_ADCCTL2_CLKDIV2EN_BITS (1 << 0)
	Defines the location of the CLKDIV2EN bits in the ADCTL2 register. More...

#define	ADC_ADCCTL2_CLKDIV4EN_BITS (1 << 2)
	Defines the location of the CLKDIV4EN bits in the ADCTL2 register. More...

#define	ADC_ADCCTL2_ADCNONOVERLAP_BITS (1 << 1)
	Defines the location of the ADCNONOVERLAP bits in the ADCTL2 register. More...

#define	ADC_INTSELxNy_NUMBITS_PER_REG 8
	Defines the number of bits per INTSELxNy register. More...

#define	ADC_INTSELxNy_LOG2_NUMBITS_PER_REG 3
	Defines the log2() of the number of bits per INTSELxNy register. More...

#define	ADC_INTSELxNy_INTSEL_BITS (31 << 0)
	Defines the location of the INTSEL bits in the INTSELxNy register. More...

#define	ADC_INTSELxNy_INTE_BITS (1 << 5)
	Defines the location of the INTE bits in the INTSELxNy register. More...

#define	ADC_INTSELxNy_INTCONT_BITS (1 << 6)
	Defines the location of the INTCONT bits in the INTSELxNy register. More...

#define	ADC_ADCSOCxCTL_ACQPS_BITS (63 << 0)
	Defines the location of the ACQPS bits in the ADCSOCxCTL register. More...

#define	ADC_ADCSOCxCTL_CHSEL_BITS (15 << 6)
	Defines the location of the CHSEL bits in the ADCSOCxCTL register. More...

#define	ADC_ADCSOCxCTL_TRIGSEL_BITS (31 << 11)
	Defines the location of the TRIGSEL bits in the ADCSOCxCTL register. More...

#define	ADC_ADCINTSOCSELx_SOCx_BITS 3
	Defines the location of the SOCx bits in the ADCINTSOCSELx register. More...

#define	ADC_ADCSAMPLEMODE_SIMULEN0_BITS (1 << 0)
	Defines the location of the SIMULEN0 bits in the ADCSAMPLEMODE register. More...

#define	ADC_ADCSAMPLEMODE_SIMULEN2_BITS (1 << 1)
	Defines the location of the SIMULEN2 bits in the ADCSAMPLEMODE register. More...

#define	ADC_ADCSAMPLEMODE_SIMULEN4_BITS (1 << 2)
	Defines the location of the SIMULEN4 bits in the ADCSAMPLEMODE register. More...

#define	ADC_ADCSAMPLEMODE_SIMULEN6_BITS (1 << 3)
	Defines the location of the SIMULEN6 bits in the ADCSAMPLEMODE register. More...

#define	ADC_ADCSAMPLEMODE_SIMULEN8_BITS (1 << 4)
	Defines the location of the SIMULEN8 bits in the ADCSAMPLEMODE register. More...

#define	ADC_ADCSAMPLEMODE_SIMULEN10_BITS (1 << 5)
	Defines the location of the SIMULEN10 bits in the ADCSAMPLEMODE register. More...

#define	ADC_ADCSAMPLEMODE_SIMULEN12_BITS (1 << 6)
	Defines the location of the SIMULEN12 bits in the ADCSAMPLEMODE register. More...

#define	ADC_ADCSAMPLEMODE_SIMULEN14_BITS (1 << 7)
	Defines the location of the SIMULEN14 bits in the ADCSAMPLEMODE register. More...

#define	ADC_ADCSAMPLEMODE_SEPARATE_FLAG 0x100
	Define for the channel separate flag. More...

Typedefs
typedef struct _ADC_Obj_	ADC_Obj
	Defines the analog-to-digital converter (ADC) object. More...

typedef struct _ADC_Obj_ *	ADC_Handle
	Defines the analog-to-digital converter (ADC) handle. More...

Enumerations
enum	ADC_DivideSelect_e { ADC_DivideSelect_ClkIn_by_1 =0, ADC_DivideSelect_ClkIn_by_2 =1, ADC_DivideSelect_ClkIn_by_4 =5 }
	Enumeration to define the start of conversion (SOC) numbers. More...

enum	ADC_IntNumber_e { ADC_IntNumber_1 =0, ADC_IntNumber_2, ADC_IntNumber_3, ADC_IntNumber_4, ADC_IntNumber_5, ADC_IntNumber_6, ADC_IntNumber_7, ADC_IntNumber_8, ADC_IntNumber_9, ADC_IntNumber_1HP, ADC_IntNumber_2HP, ADC_IntNumber_9HP =0xE }
	Enumeration to define the analog-to-digital converter (ADC) interrupt number. More...

enum	ADC_IntMode_e { ADC_IntMode_ClearFlag =(0 << 6), ADC_IntMode_EOC =(1 << 6) }
	Enumeration to define the analog-to-digital converter (ADC) interrupt mode. More...

enum	ADC_ADCCTL2_ADCNONOVERLAP_e { ADC_ADCCTL2_Overlap =0, ADC_ADCCTL2_NoOverlap }
	Enumeration to define the analog-to-digital converter (ADC) sample and conversion overlap setting. More...

enum	ADC_IntTriggerSOC_e { ADC_NoIntTriggersSOC =0, ADC_Int1TriggersSOC, ADC_Int2TriggersSOC }
	Enumeration to define the analog-to-digital converter (ADC) input trigger SOC Select 1 Register group of bits. More...

enum	ADC_IntPulseGenMode_e { ADC_IntPulseGenMode_During =(0 << 2), ADC_IntPulseGenMode_Prior =(1 << 2) }
	Enumeration to define the analog-to-digital converter (ADC) interrupt pulse generation mode. More...

enum	ADC_IntSrc_e { ADC_IntSrc_EOC0 =(0 << 0), ADC_IntSrc_EOC1 =(1 << 0), ADC_IntSrc_EOC2 =(2 << 0), ADC_IntSrc_EOC3 =(3 << 0), ADC_IntSrc_EOC4 =(4 << 0), ADC_IntSrc_EOC5 =(5 << 0), ADC_IntSrc_EOC6 =(6 << 0), ADC_IntSrc_EOC7 =(7 << 0), ADC_IntSrc_EOC8 =(8 << 0), ADC_IntSrc_EOC9 =(9 << 0), ADC_IntSrc_EOC10 =(10 << 0), ADC_IntSrc_EOC11 =(11 << 0), ADC_IntSrc_EOC12 =(12 << 0), ADC_IntSrc_EOC13 =(13 << 0), ADC_IntSrc_EOC14 =(14 << 0), ADC_IntSrc_EOC15 =(15 << 0) }
	Enumeration to define the analog-to-digital converter (ADC) interrupt source. More...

enum	ADC_ResultNumber_e { ADC_ResultNumber_0 =0, ADC_ResultNumber_1, ADC_ResultNumber_2, ADC_ResultNumber_3, ADC_ResultNumber_4, ADC_ResultNumber_5, ADC_ResultNumber_6, ADC_ResultNumber_7, ADC_ResultNumber_8, ADC_ResultNumber_9, ADC_ResultNumber_10, ADC_ResultNumber_11, ADC_ResultNumber_12, ADC_ResultNumber_13, ADC_ResultNumber_14, ADC_ResultNumber_15 }
	Enumeration to define the analog-to-digital converter (ADC) result number. More...

enum	ADC_SampleMode_e { ADC_SampleMode_SOC0_and_SOC1_Separate =ADC_ADCSAMPLEMODE_SEPARATE_FLAG + (1 << 0), ADC_SampleMode_SOC2_and_SOC3_Separate =ADC_ADCSAMPLEMODE_SEPARATE_FLAG + (1 << 1), ADC_SampleMode_SOC4_and_SOC5_Separate =ADC_ADCSAMPLEMODE_SEPARATE_FLAG + (1 << 2), ADC_SampleMode_SOC6_and_SOC7_Separate =ADC_ADCSAMPLEMODE_SEPARATE_FLAG + (1 << 3), ADC_SampleMode_SOC8_and_SOC9_Separate =ADC_ADCSAMPLEMODE_SEPARATE_FLAG + (1 << 4), ADC_SampleMode_SOC10_and_SOC11_Separate =ADC_ADCSAMPLEMODE_SEPARATE_FLAG + (1 << 5), ADC_SampleMode_SOC12_and_SOC13_Separate =ADC_ADCSAMPLEMODE_SEPARATE_FLAG + (1 << 6), ADC_SampleMode_SOC14_and_SOC15_Separate =ADC_ADCSAMPLEMODE_SEPARATE_FLAG + (1 << 7), ADC_SampleMode_SOC0_and_SOC1_Together =(1 << 0), ADC_SampleMode_SOC2_and_SOC3_Together =(1 << 1), ADC_SampleMode_SOC4_and_SOC5_Together =(1 << 2), ADC_SampleMode_SOC6_and_SOC7_Together =(1 << 3), ADC_SampleMode_SOC8_and_SOC9_Together =(1 << 4), ADC_SampleMode_SOC10_and_SOC11_Together =(1 << 5), ADC_SampleMode_SOC12_and_SOC13_Together =(1 << 6), ADC_SampleMode_SOC14_and_SOC15_Together =(1 << 7) }
	Enumeration to define the analog-to-digital converter (ADC) sample modes. More...

enum	ADC_SocChanNumber_e { ADC_SocChanNumber_A0 =(0 << 6), ADC_SocChanNumber_A1 =(1 << 6), ADC_SocChanNumber_A2 =(2 << 6), ADC_SocChanNumber_A3 =(3 << 6), ADC_SocChanNumber_A4 =(4 << 6), ADC_SocChanNumber_A5 =(5 << 6), ADC_SocChanNumber_A6 =(6 << 6), ADC_SocChanNumber_A7 =(7 << 6), ADC_SocChanNumber_B0 =(8 << 6), ADC_SocChanNumber_B1 =(9 << 6), ADC_SocChanNumber_B2 =(10 << 6), ADC_SocChanNumber_B3 =(11 << 6), ADC_SocChanNumber_B4 =(12 << 6), ADC_SocChanNumber_B5 =(13 << 6), ADC_SocChanNumber_B6 =(14 << 6), ADC_SocChanNumber_B7 =(15 << 6), ADC_SocChanNumber_A0_and_B0_Together =(0 << 6), ADC_SocChanNumber_A1_and_B1_Together =(1 << 6), ADC_SocChanNumber_A2_and_B2_Together =(2 << 6), ADC_SocChanNumber_A3_and_B3_Together =(3 << 6), ADC_SocChanNumber_A4_and_B4_Together =(4 << 6), ADC_SocChanNumber_A5_and_B5_Together =(5 << 6), ADC_SocChanNumber_A6_and_B6_Together =(6 << 6), ADC_SocChanNumber_A7_and_B7_Together =(7 << 6) }
	Enumeration to define the start of conversion (SOC) channel numbers. More...

enum	ADC_SocNumber_e { ADC_SocNumber_0 =0, ADC_SocNumber_1, ADC_SocNumber_2, ADC_SocNumber_3, ADC_SocNumber_4, ADC_SocNumber_5, ADC_SocNumber_6, ADC_SocNumber_7, ADC_SocNumber_8, ADC_SocNumber_9, ADC_SocNumber_10, ADC_SocNumber_11, ADC_SocNumber_12, ADC_SocNumber_13, ADC_SocNumber_14, ADC_SocNumber_15 }
	Enumeration to define the start of conversion (SOC) numbers. More...

enum	ADC_SocSampleDelay_e { ADC_SocSampleDelay_7_cycles =6, ADC_SocSampleDelay_8_cycles =7, ADC_SocSampleDelay_9_cycles =8, ADC_SocSampleDelay_10_cycles =9, ADC_SocSampleDelay_11_cycles =10, ADC_SocSampleDelay_12_cycles =11, ADC_SocSampleDelay_13_cycles =12, ADC_SocSampleDelay_14_cycles =13, ADC_SocSampleDelay_15_cycles =14, ADC_SocSampleDelay_16_cycles =15, ADC_SocSampleDelay_22_cycles =21, ADC_SocSampleDelay_23_cycles =22, ADC_SocSampleDelay_24_cycles =23, ADC_SocSampleDelay_25_cycles =24, ADC_SocSampleDelay_26_cycles =25, ADC_SocSampleDelay_27_cycles =26, ADC_SocSampleDelay_28_cycles =27, ADC_SocSampleDelay_29_cycles =28, ADC_SocSampleDelay_35_cycles =34, ADC_SocSampleDelay_36_cycles =35, ADC_SocSampleDelay_37_cycles =36, ADC_SocSampleDelay_38_cycles =37, ADC_SocSampleDelay_39_cycles =38, ADC_SocSampleDelay_40_cycles =39, ADC_SocSampleDelay_41_cycles =40, ADC_SocSampleDelay_42_cycles =41, ADC_SocSampleDelay_48_cycles =47, ADC_SocSampleDelay_49_cycles =48, ADC_SocSampleDelay_50_cycles =49, ADC_SocSampleDelay_51_cycles =50, ADC_SocSampleDelay_52_cycles =51, ADC_SocSampleDelay_53_cycles =52, ADC_SocSampleDelay_54_cycles =53, ADC_SocSampleDelay_55_cycles =54, ADC_SocSampleDelay_61_cycles =60, ADC_SocSampleDelay_62_cycles =61, ADC_SocSampleDelay_63_cycles =62, ADC_SocSampleDelay_64_cycles =63 }
	Enumeration to define the start of conversion (SOC) sample delays. More...

enum	ADC_SocTrigSrc_e { ADC_SocTrigSrc_Sw =(0 << 11), ADC_SocTrigSrc_CpuTimer_0 =(1 << 11), ADC_SocTrigSrc_CpuTimer_1 =(2 << 11), ADC_SocTrigSrc_CpuTimer_2 =(3 << 11), ADC_SocTrigSrc_XINT2_XINT2SOC =(4 << 11), ADC_SocTrigSrc_EPWM1_ADCSOCA =(5 << 11), ADC_SocTrigSrc_EPWM1_ADCSOCB =(6 << 11), ADC_SocTrigSrc_EPWM2_ADCSOCA =(7 << 11), ADC_SocTrigSrc_EPWM2_ADCSOCB =(8 << 11), ADC_SocTrigSrc_EPWM3_ADCSOCA =(9 << 11), ADC_SocTrigSrc_EPWM3_ADCSOCB =(10 << 11), ADC_SocTrigSrc_EPWM4_ADCSOCA =(11 << 11), ADC_SocTrigSrc_EPWM4_ADCSOCB =(12 << 11), ADC_SocTrigSrc_EPWM5_ADCSOCA =(13 << 11), ADC_SocTrigSrc_EPWM5_ADCSOCB =(14 << 11), ADC_SocTrigSrc_EPWM6_ADCSOCA =(15 << 11), ADC_SocTrigSrc_EPWM6_ADCSOCB =(16 << 11), ADC_SocTrigSrc_EPWM7_ADCSOCA =(17 << 11), ADC_SocTrigSrc_EPWM7_ADCSOCB =(18 << 11), ADC_SocTrigSrc_EPWM8_ADCSOCA =(19 << 11), ADC_SocTrigSrc_EPWM8_ADCSOCB =(20 << 11) }
	Enumeration to define the start of conversion (SOC) trigger source. More...

enum	ADC_TempSensorSrc_e { ADC_TempSensorSrc_Ext =0, ADC_TempSensorSrc_Int }
	Enumeration to define the temperature sensor source. More...

enum	ADC_VoltageRefSrc_e { ADC_VoltageRefSrc_Int =(0 << 3), ADC_VoltageRefSrc_Ext =(1 << 3) }
	Enumeration to define the voltage reference source. More...

enum	ADC_SocFrc_e { ADC_SocFrc_0 =0, ADC_SocFrc_1, ADC_SocFrc_2, ADC_SocFrc_3, ADC_SocFrc_4, ADC_SocFrc_5, ADC_SocFrc_6, ADC_SocFrc_7, ADC_SocFrc_8, ADC_SocFrc_9, ADC_SocFrc_10, ADC_SocFrc_11, ADC_SocFrc_12, ADC_SocFrc_13, ADC_SocFrc_14, ADC_SocFrc_15 }
	Enumeration to define the soc force values. More...

Functions
static void	ADC_clearIntFlag (ADC_Handle adcHandle, const ADC_IntNumber_e intNumber)
	Clears the analog-to-digital converter (ADC) interrupt flag. More...

static bool	ADC_getIntFlag (ADC_Handle adcHandle, const ADC_IntNumber_e intNumber)
	Gets the analog-to-digital converter (ADC) interrupt flag. More...

void	ADC_disable (ADC_Handle adcHandle)
	Disables the analog-to-digital converter (ADC) More...

void	ADC_disableBandGap (ADC_Handle adcHandle)
	Disables the analog-to-digital converter (ADC) band gap circuit. More...

void	ADC_disableInt (ADC_Handle adcHandle, const ADC_IntNumber_e intNumber)
	Disables the analog-to-digital converter (ADC) interrupt. More...

void	ADC_disableRefBuffers (ADC_Handle adcHandle)
	Disables the analog-to-digital converter (ADC) reference buffers circuit. More...

void	ADC_enable (ADC_Handle adcHandle)
	Enables the analog-to-digital converter (ADC) More...

void	ADC_enableBandGap (ADC_Handle adcHandle)
	Enables the analog-to-digital converter (ADC) band gap circuit. More...

void	ADC_enableInt (ADC_Handle adcHandle, const ADC_IntNumber_e intNumber)
	Enables the analog-to-digital converter (ADC) interrupt. More...

void	ADC_enableRefBuffers (ADC_Handle adcHandle)
	Enables the analog-to-digital converter (ADC) reference buffers circuit. More...

ADC_DivideSelect_e	ADC_getDivideSelect (ADC_Handle adcHandle)
	Gets the analog-to-digital converter (ADC) divide select value. More...

static ADC_SocSampleDelay_e	ADC_getSocSampleDelay (ADC_Handle adcHandle, const ADC_SocNumber_e socNumber)
	Gets the analog-to-digital converter (ADC) start-of-conversion (SOC) sample delay value. More...

ADC_Handle	ADC_init (void *pMemory, const size_t numBytes)
	Initializes the analog-to-digital converter (ADC) object handle. More...

void	ADC_powerDown (ADC_Handle adcHandle)
	Powers down the analog-to-digital converter (ADC) More...

void	ADC_powerUp (ADC_Handle adcHandle)
	Powers up the analog-to-digital converter (ADC) More...

static uint_least16_t	ADC_readResult (ADC_Handle adcHandle, const ADC_ResultNumber_e resultNumber)
	Reads the specified ADC result (i.e. value) More...

void	ADC_reset (ADC_Handle adcHandle)
	Resets the analog-to-digital converter (ADC) More...

void	ADC_setDivideSelect (ADC_Handle adcHandle, const ADC_DivideSelect_e divSelect)
	Sets the analog-to-digital converter (ADC) divide select value. More...

void	ADC_setIntMode (ADC_Handle adcHandle, const ADC_IntNumber_e intNumber, const ADC_IntMode_e intMode)
	Sets the interrupt mode. More...

void	ADC_setIntPulseGenMode (ADC_Handle adcHandle, const ADC_IntPulseGenMode_e pulseMode)
	Sets the interrupt pulse generation mode. More...

void	ADC_setIntSrc (ADC_Handle adcHandle, const ADC_IntNumber_e intNumber, const ADC_IntSrc_e intSrc)
	Sets the interrupt source. More...

void	ADC_setSampleMode (ADC_Handle adcHandle, const ADC_SampleMode_e sampleMode)
	Sets the sample mode. More...

void	ADC_setSocChanNumber (ADC_Handle adcHandle, const ADC_SocNumber_e socNumber, const ADC_SocChanNumber_e chanNumber)
	Sets the start-of-conversion (SOC) channel number. More...

void	ADC_setSocSampleDelay (ADC_Handle adcHandle, const ADC_SocNumber_e socNumber, const ADC_SocSampleDelay_e sampleDelay)
	Sets the start-of-conversion (SOC) sample delay. More...

void	ADC_setSocTrigSrc (ADC_Handle adcHandle, const ADC_SocNumber_e socNumber, const ADC_SocTrigSrc_e trigSrc)
	Sets the start-of-conversion (SOC) trigger source. More...

void	ADC_setSocFrc (ADC_Handle adcHandle, const ADC_SocFrc_e socFrc)
	Sets the start-of-conversion (SOC) force register. More...

void	ADC_setTempSensorSrc (ADC_Handle adcHandle, const ADC_TempSensorSrc_e sensorSrc)
	Sets the temperature sensor source. More...

void	ADC_setVoltRefSrc (ADC_Handle adcHandle, const ADC_VoltageRefSrc_e voltRef)
	Sets the voltage reference source. More...

void	ADC_setOffTrim (ADC_Handle adcHandle, const uint16_t offtrim)
	Sets the offset trim register. More...

void	ADC_enableVoltRefLoConv (ADC_Handle adcHandle)
	Enables conversion of the voltage reference low signal for calibration. More...

void	ADC_disableVoltRefLoConv (ADC_Handle adcHandle)
	Disables conversion of the voltage reference low signal for calibration. More...

void	ADC_setupSocTrigSrc (ADC_Handle adcHandle, const ADC_SocNumber_e socNumber, const ADC_IntTriggerSOC_e intTrigSrc)
	Sets the start of conversion (SOC) trigger source. More...

void	ADC_setSocFrcWord (ADC_Handle adcHandle, const uint16_t socFrc)
	Sets the entire start of conversion (SOC) force register. More...

void	ADC_enableNoOverlapMode (ADC_Handle adcHandle)
	Enables no overlap mode. More...

void	ADC_disableNoOverlapMode (ADC_Handle adcHandle)
	Disables no overlap mode. More...

Detailed Description

Contains public interface to various functions related to the analog-to-digital converter (ADC) object.

Definition in file adc.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description