AM263Px MCU+ SDK  10.01.00

Introduction

This module contains APIs to program and use the ADC module.

Data Structures

struct  ADC_RepeaterConfig
 

Functions

static void ADC_setPrescaler (uint32_t base, ADC_ClkPrescale clkPrescale)
 
static void ADC_setupSOC (uint32_t base, ADC_SOCNumber socNumber, ADC_Trigger trigger, ADC_Channel channel, uint32_t sampleWindow)
 
static void ADC_selectSOCExtChannel (uint32_t base, ADC_SOCNumber socNumber, uint16_t extChannel)
 
static void ADC_forceRepeaterTrigger (uint32_t base, uint16_t repInstance)
 
static uint16_t ADC_getRepeaterStatus (uint32_t base, uint16_t repInstance)
 
static void ADC_setInterruptSOCTrigger (uint32_t base, ADC_SOCNumber socNumber, ADC_IntSOCTrigger trigger)
 
static void ADC_setInterruptPulseMode (uint32_t base, ADC_PulseMode pulseMode)
 
static void ADC_setInterruptCycleOffset (uint32_t base, uint16_t cycleOffset)
 
static void ADC_enableAltDMATiming (uint32_t base)
 
static void ADC_disableAltDMATiming (uint32_t base)
 
static void ADC_enableExtMuxPreselect (uint32_t base)
 
static void ADC_disableExtMuxPreselect (uint32_t base)
 
static void ADC_selectOffsetTrimMode (uint32_t base, ADC_OffsetTrim mode)
 
static bool ADC_getIntResultStatus (uint32_t base, ADC_IntNumber adcIntNum)
 
static void ADC_enableConverter (uint32_t base)
 
static void ADC_disableConverter (uint32_t base)
 
static void ADC_forceSOC (uint32_t base, ADC_SOCNumber socNumber)
 
static void ADC_forceMultipleSOC (uint32_t base, uint16_t socMask)
 
static bool ADC_getInterruptStatus (uint32_t base, ADC_IntNumber adcIntNum)
 
static void ADC_clearInterruptStatus (uint32_t base, ADC_IntNumber adcIntNum)
 
static bool ADC_getInterruptOverflowStatus (uint32_t base, ADC_IntNumber adcIntNum)
 
static void ADC_clearInterruptOverflowStatus (uint32_t base, ADC_IntNumber adcIntNum)
 
static uint16_t ADC_readResult (uint32_t resultBase, ADC_SOCNumber socNumber)
 
static bool ADC_isBusy (uint32_t base)
 
static void ADC_setBurstModeConfig (uint32_t base, ADC_Trigger trigger, uint16_t burstSize)
 
static void ADC_enableBurstMode (uint32_t base)
 
static void ADC_disableBurstMode (uint32_t base)
 
static void ADC_setSOCPriority (uint32_t base, ADC_PriorityMode priMode)
 
static void ADC_configOSDetectMode (uint32_t base, ADC_OSDetectMode modeVal)
 
static void ADC_setupPPB (uint32_t base, ADC_PPBNumber ppbNumber, ADC_SOCNumber socNumber)
 
static void ADC_enablePPBEvent (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t evtFlags)
 
static void ADC_disablePPBEvent (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t evtFlags)
 
static void ADC_enablePPBEventInterrupt (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t intFlags)
 
static void ADC_disablePPBEventInterrupt (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t intFlags)
 
static uint16_t ADC_getPPBEventStatus (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_clearPPBEventStatus (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t evtFlags)
 
static void ADC_enablePPBEventCBCClear (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_disablePPBEventCBCClear (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_setPPBCountLimit (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t limit)
 
static uint16_t ADC_getPPBCountLimit (uint32_t base, ADC_PPBNumber ppbNumber)
 
static uint16_t ADC_readPPBPCount (uint32_t base, ADC_PPBNumber ppbNumber)
 
static int32_t ADC_readPPBPSum (uint32_t base, ADC_PPBNumber ppbNumber)
 
static int32_t ADC_readPPBPMax (uint32_t base, ADC_PPBNumber ppbNumber)
 
static int32_t ADC_readPPBPMin (uint32_t base, ADC_PPBNumber ppbNumber)
 
static uint16_t ADC_readPPBPMaxIndex (uint32_t base, ADC_PPBNumber ppbNumber)
 
static uint16_t ADC_readPPBPMinIndex (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_enablePPBAbsoluteValue (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_disablePPBAbsoluteValue (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_setPPBShiftValue (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t shiftVal)
 
static void ADC_selectPPBSyncInput (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t syncInput)
 
static void ADC_forcePPBSync (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_selectPPBOSINTSource (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t osIntSrc)
 
static void ADC_selectPPBCompareSource (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t compSrc)
 
static int32_t ADC_readPPBSum (uint32_t resultBase, ADC_PPBNumber ppbNumber)
 
static uint32_t ADC_readPPBCount (uint32_t resultBase, ADC_PPBNumber ppbNumber)
 
static int32_t ADC_readPPBMax (uint32_t resultBase, ADC_PPBNumber ppbNumber)
 
static int32_t ADC_readPPBMin (uint32_t resultBase, ADC_PPBNumber ppbNumber)
 
static uint16_t ADC_readPPBMaxIndex (uint32_t resultBase, ADC_PPBNumber ppbNumber)
 
static uint16_t ADC_readPPBMinIndex (uint32_t resultBase, ADC_PPBNumber ppbNumber)
 
static int32_t ADC_readPPBResult (uint32_t resultBase, ADC_PPBNumber ppbNumber)
 
static uint16_t ADC_getPPBDelayTimeStamp (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_setPPBCalibrationOffset (uint32_t base, ADC_PPBNumber ppbNumber, int16_t offset)
 
static void ADC_setPPBReferenceOffset (uint32_t base, ADC_PPBNumber ppbNumber, uint16_t offset)
 
static void ADC_enablePPBTwosComplement (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_disablePPBTwosComplement (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_enablePPBExtendedLowLimit (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_disablePPBExtendedLowLimit (uint32_t base, ADC_PPBNumber ppbNumber)
 
static void ADC_enableInterrupt (uint32_t base, ADC_IntNumber adcIntNum)
 
static void ADC_disableInterrupt (uint32_t base, ADC_IntNumber adcIntNum)
 
static void ADC_setInterruptSource (uint32_t base, ADC_IntNumber adcIntNum, uint16_t intTrigger)
 
static void ADC_enableContinuousMode (uint32_t base, ADC_IntNumber adcIntNum)
 
static void ADC_disableContinuousMode (uint32_t base, ADC_IntNumber adcIntNum)
 
static void ADC_configSOCSafetyCheckerInput (uint32_t base, ADC_SOCNumber socNumber, ADC_SafetyCheckerInput scInput)
 
static void ADC_enableSafetyChecker (uint32_t scBase)
 
static void ADC_disableSafetyChecker (uint32_t scBase)
 
static void ADC_forceSafetyCheckerSync (uint32_t scBase)
 
static uint16_t ADC_getSafetyCheckerStatus (uint32_t scBase)
 
static void ADC_configureSafetyChecker (uint32_t scBase, ADC_SafetyCheckInst checkInst, ADC_Select adcInst, ADC_ResultSelect adcResultInst)
 
static void ADC_setSafetyCheckerTolerance (uint32_t scBase, uint32_t tolerance)
 
static uint32_t ADC_getSafetyCheckerResult (uint32_t scBase, ADC_SafetyCheckInst checkInst)
 
static void ADC_enableSafetyCheckEvt (uint32_t scIntEvtBase, ADC_Checker checkerNumber, ADC_SafetyCheckEvent checkEvent, ADC_SafetyCheckResult checkResult)
 
static void ADC_disableSafetyCheckEvt (uint32_t scIntEvtBase, ADC_Checker checkerNumber, ADC_SafetyCheckEvent checkEvent, ADC_SafetyCheckResult checkResult)
 
static void ADC_enableSafetyCheckInt (uint32_t scIntEvtBase, ADC_Checker checkerNumber, ADC_SafetyCheckResult checkResult)
 
static void ADC_disableSafetyCheckInt (uint32_t scIntEvtBase, ADC_Checker checkerNumber, ADC_SafetyCheckResult checkResult)
 
static bool ADC_getSafetyCheckStatus (uint32_t scIntEvtBase, ADC_Checker checkerNumber, ADC_SafetyCheckFlag checkerFlag)
 
static void ADC_clearSafetyCheckStatus (uint32_t scIntEvtBase, ADC_Checker checkerNumber, ADC_SafetyCheckFlag checkerFlag)
 
static uint32_t ADC_getSafetyCheckIntStatus (uint32_t scIntEvtBase)
 
static void ADC_clearSafetyCheckIntStatus (uint32_t scIntEvtBase)
 
static void ADC_triggerRepeaterMode (uint32_t base, uint32_t repInstance, ADC_RepMode mode)
 
static bool ADC_triggerRepeaterActiveMode (uint32_t base, uint32_t repInstance)
 
static bool ADC_triggerRepeaterModuleBusy (uint32_t base, uint32_t repInstance)
 
static void ADC_triggerRepeaterSelect (uint32_t base, uint16_t repInstance, ADC_Trigger trigger)
 
static void ADC_triggerRepeaterSyncIn (uint32_t base, uint16_t repInstance, ADC_SyncInput syncInput)
 
static void ADC_forceRepeaterTriggerSync (uint32_t base, uint16_t repInstance)
 
static void ADC_triggerRepeaterCount (uint32_t base, uint16_t repInstance, uint16_t repCount)
 
static void ADC_triggerRepeaterPhase (uint32_t base, uint16_t repInstance, uint16_t repPhase)
 
static void ADC_triggerRepeaterSpread (uint32_t base, uint16_t repInstance, uint16_t repSpread)
 
void ADC_setMode (uint32_t base, ADC_Resolution resolution, ADC_SignalMode signalMode)
 
void ADC_setPPBTripLimits (uint32_t base, ADC_PPBNumber ppbNumber, int32_t tripHiLimit, int32_t tripLoLimit)
 

Enumerations

enum  ADC_ClkPrescale {
  ADC_CLK_DIV_1_0 = 0, ADC_CLK_DIV_2_0 = 2, ADC_CLK_DIV_2_5 = 3, ADC_CLK_DIV_3_0 = 4,
  ADC_CLK_DIV_3_5 = 5, ADC_CLK_DIV_4_0 = 6, ADC_CLK_DIV_4_5 = 7, ADC_CLK_DIV_5_0 = 8,
  ADC_CLK_DIV_5_5 = 9, ADC_CLK_DIV_6_0 = 10, ADC_CLK_DIV_6_5 = 11, ADC_CLK_DIV_7_0 = 12,
  ADC_CLK_DIV_7_5 = 13, ADC_CLK_DIV_8_0 = 14, ADC_CLK_DIV_8_5 = 15
}
 
enum  ADC_Resolution { ADC_RESOLUTION_12BIT = 0 }
 
enum  ADC_SignalMode { ADC_MODE_SINGLE_ENDED = 0, ADC_MODE_DIFFERENTIAL = 1 }
 
enum  ADC_Trigger {
  ADC_TRIGGER_SW_ONLY = 0x00, ADC_TRIGGER_RTI0 = 0x01, ADC_TRIGGER_RTI1 = 0x02, ADC_TRIGGER_RTI2 = 0x03,
  ADC_TRIGGER_RTI3 = 0x04, ADC_TRIGGER_INPUT_XBAR_OUT5 = 0x05, ADC_TRIGGER_EPWM0_SOCA = 0x08, ADC_TRIGGER_EPWM0_SOCB = 0x09,
  ADC_TRIGGER_EPWM1_SOCA = 0x0A, ADC_TRIGGER_EPWM1_SOCB = 0x0B, ADC_TRIGGER_EPWM2_SOCA = 0x0C, ADC_TRIGGER_EPWM2_SOCB = 0x0D,
  ADC_TRIGGER_EPWM3_SOCA = 0x0E, ADC_TRIGGER_EPWM3_SOCB = 0x0F, ADC_TRIGGER_EPWM4_SOCA = 0x10, ADC_TRIGGER_EPWM4_SOCB = 0x11,
  ADC_TRIGGER_EPWM5_SOCA = 0x12, ADC_TRIGGER_EPWM5_SOCB = 0x13, ADC_TRIGGER_EPWM6_SOCA = 0x14, ADC_TRIGGER_EPWM6_SOCB = 0x15,
  ADC_TRIGGER_EPWM7_SOCA = 0x16, ADC_TRIGGER_EPWM7_SOCB = 0x17, ADC_TRIGGER_EPWM8_SOCA = 0x18, ADC_TRIGGER_EPWM8_SOCB = 0x19,
  ADC_TRIGGER_EPWM9_SOCA = 0x1A, ADC_TRIGGER_EPWM9_SOCB = 0x1B, ADC_TRIGGER_EPWM10_SOCA = 0x1C, ADC_TRIGGER_EPWM10_SOCB = 0x1D,
  ADC_TRIGGER_EPWM11_SOCA = 0x1E, ADC_TRIGGER_EPWM11_SOCB = 0x1F, ADC_TRIGGER_EPWM12_SOCA = 0x20, ADC_TRIGGER_EPWM12_SOCB = 0x21,
  ADC_TRIGGER_EPWM13_SOCA = 0x22, ADC_TRIGGER_EPWM13_SOCB = 0x23, ADC_TRIGGER_EPWM14_SOCA = 0x24, ADC_TRIGGER_EPWM14_SOCB = 0x25,
  ADC_TRIGGER_EPWM15_SOCA = 0x26, ADC_TRIGGER_EPWM15_SOCB = 0x27, ADC_TRIGGER_EPWM16_SOCA = 0x28, ADC_TRIGGER_EPWM16_SOCB = 0x29,
  ADC_TRIGGER_EPWM17_SOCA = 0x2A, ADC_TRIGGER_EPWM17_SOCB = 0x2B, ADC_TRIGGER_EPWM18_SOCA = 0x2C, ADC_TRIGGER_EPWM18_SOCB = 0x2D,
  ADC_TRIGGER_EPWM19_SOCA = 0x2E, ADC_TRIGGER_EPWM19_SOCB = 0x2F, ADC_TRIGGER_EPWM20_SOCA = 0x30, ADC_TRIGGER_EPWM20_SOCB = 0x31,
  ADC_TRIGGER_EPWM21_SOCA = 0x32, ADC_TRIGGER_EPWM21_SOCB = 0x33, ADC_TRIGGER_EPWM22_SOCA = 0x34, ADC_TRIGGER_EPWM22_SOCB = 0x35,
  ADC_TRIGGER_EPWM23_SOCA = 0x36, ADC_TRIGGER_EPWM23_SOCB = 0x37, ADC_TRIGGER_EPWM24_SOCA = 0x38, ADC_TRIGGER_EPWM24_SOCB = 0x39,
  ADC_TRIGGER_EPWM25_SOCA = 0x3A, ADC_TRIGGER_EPWM25_SOCB = 0x3B, ADC_TRIGGER_EPWM26_SOCA = 0x3C, ADC_TRIGGER_EPWM26_SOCB = 0x3D,
  ADC_TRIGGER_EPWM27_SOCA = 0x3E, ADC_TRIGGER_EPWM27_SOCB = 0x3F, ADC_TRIGGER_EPWM28_SOCA = 0x40, ADC_TRIGGER_EPWM28_SOCB = 0x41,
  ADC_TRIGGER_EPWM29_SOCA = 0x42, ADC_TRIGGER_EPWM29_SOCB = 0x43, ADC_TRIGGER_EPWM30_SOCA = 0x44, ADC_TRIGGER_EPWM30_SOCB = 0x45,
  ADC_TRIGGER_EPWM31_SOCA = 0x46, ADC_TRIGGER_EPWM31_SOCB = 0x47, ADC_TRIGGER_ECAP0_SOCEVT = 0x48, ADC_TRIGGER_ECAP1_SOCEVT = 0x49,
  ADC_TRIGGER_ECAP2_SOCEVT = 0x4A, ADC_TRIGGER_ECAP3_SOCEVT = 0x4B, ADC_TRIGGER_ECAP4_SOCEVT = 0x4C, ADC_TRIGGER_ECAP5_SOCEVT = 0x4D,
  ADC_TRIGGER_ECAP6_SOCEVT = 0x4E, ADC_TRIGGER_ECAP7_SOCEVT = 0x4F, ADC_TRIGGER_ECAP8_SOCEVT = 0x50, ADC_TRIGGER_ECAP9_SOCEVT = 0x51,
  ADC_TRIGGER_ECAP10_SOCEVT = 0x52, ADC_TRIGGER_ECAP11_SOCEVT = 0x53, ADC_TRIGGER_ECAP12_SOCEVT = 0x54, ADC_TRIGGER_ECAP13_SOCEVT = 0x55,
  ADC_TRIGGER_ECAP14_SOCEVT = 0x56, ADC_TRIGGER_ECAP15_SOCEVT = 0x57, ADC_TRIGGER_RTI4 = 0x58, ADC_TRIGGER_RTI5 = 0x59,
  ADC_TRIGGER_RTI6 = 0x5A, ADC_TRIGGER_RTI7 = 0x5B, ADC_TRIGGER_REPEATER1 = 0x7E, ADC_TRIGGER_REPEATER2 = 0x7F
}
 
enum  ADC_Channel {
  ADC_CH_ADCIN0 = 0, ADC_CH_ADCIN1 = 1, ADC_CH_ADCIN2 = 2, ADC_CH_ADCIN3 = 3,
  ADC_CH_ADCIN4 = 4, ADC_CH_ADCIN5 = 5, ADC_CH_ADCIN6 = 7, ADC_CH_CAL0 = 6,
  ADC_CH_CAL1 = 7, ADC_CH_ADCIN0_ADCIN1 = 0, ADC_CH_ADCIN1_ADCIN0 = 1, ADC_CH_ADCIN2_ADCIN3 = 2,
  ADC_CH_ADCIN3_ADCIN2 = 3, ADC_CH_ADCIN4_ADCIN5 = 4, ADC_CH_ADCIN5_ADCIN4 = 5, ADC_CH_CAL0_CAL1 = 6,
  ADC_CH_CAL1_CAL0 = 7, ADC_CH_CAL0_ADCIN6 = 6, ADC_CH_ADCIN6_CAL0 = 7
}
 
enum  ADC_PulseMode { ADC_PULSE_END_OF_ACQ_WIN = 0, ADC_PULSE_END_OF_CONV = 1 }
 
enum  ADC_IntNumber { ADC_INT_NUMBER1 = 0, ADC_INT_NUMBER2 = 1, ADC_INT_NUMBER3 = 2, ADC_INT_NUMBER4 = 3 }
 
enum  ADC_PPBNumber { ADC_PPB_NUMBER1 = 0, ADC_PPB_NUMBER2 = 1, ADC_PPB_NUMBER3 = 2, ADC_PPB_NUMBER4 = 3 }
 
enum  ADC_SOCNumber {
  ADC_SOC_NUMBER0 = 0, ADC_SOC_NUMBER1 = 1, ADC_SOC_NUMBER2 = 2, ADC_SOC_NUMBER3 = 3,
  ADC_SOC_NUMBER4 = 4, ADC_SOC_NUMBER5 = 5, ADC_SOC_NUMBER6 = 6, ADC_SOC_NUMBER7 = 7,
  ADC_SOC_NUMBER8 = 8, ADC_SOC_NUMBER9 = 9, ADC_SOC_NUMBER10 = 10, ADC_SOC_NUMBER11 = 11,
  ADC_SOC_NUMBER12 = 12, ADC_SOC_NUMBER13 = 13, ADC_SOC_NUMBER14 = 14, ADC_SOC_NUMBER15 = 15
}
 
enum  ADC_IntSOCTrigger { ADC_INT_SOC_TRIGGER_NONE = 0, ADC_INT_SOC_TRIGGER_ADCINT1 = 1, ADC_INT_SOC_TRIGGER_ADCINT2 = 2 }
 
enum  ADC_PriorityMode {
  ADC_PRI_ALL_ROUND_ROBIN = 0, ADC_PRI_SOC0_HIPRI = 1, ADC_PRI_THRU_SOC1_HIPRI = 2, ADC_PRI_THRU_SOC2_HIPRI = 3,
  ADC_PRI_THRU_SOC3_HIPRI = 4, ADC_PRI_THRU_SOC4_HIPRI = 5, ADC_PRI_THRU_SOC5_HIPRI = 6, ADC_PRI_THRU_SOC6_HIPRI = 7,
  ADC_PRI_THRU_SOC7_HIPRI = 8, ADC_PRI_THRU_SOC8_HIPRI = 9, ADC_PRI_THRU_SOC9_HIPRI = 10, ADC_PRI_THRU_SOC10_HIPRI = 11,
  ADC_PRI_THRU_SOC11_HIPRI = 12, ADC_PRI_THRU_SOC12_HIPRI = 13, ADC_PRI_THRU_SOC13_HIPRI = 14, ADC_PRI_THRU_SOC14_HIPRI = 15,
  ADC_PRI_ALL_HIPRI = 16
}
 
enum  ADC_OSDetectMode {
  ADC_OSDETECT_MODE_DISABLED = 0x0U, ADC_OSDETECT_MODE_VSSA = 0x1U, ADC_OSDETECT_MODE_VDDA = 0x2U, ADC_OSDETECT_MODE_5BY12_VDDA = 0x3U,
  ADC_OSDETECT_MODE_7BY12_VDDA = 0x4U, ADC_OSDETECT_MODE_5K_PULLDOWN_TO_VSSA = 0x5U, ADC_OSDETECT_MODE_5K_PULLUP_TO_VDDA = 0x6U, ADC_OSDETECT_MODE_7K_PULLDOWN_TO_VSSA = 0x7U
}
 
enum  ADC_OffsetTrim { ADC_OFFSET_TRIM_COMMON = 0x0000U, ADC_OFFSET_TRIM_INDIVIDUAL = 0x0100U }
 
enum  ADC_SyncInput {
  ADC_SYNCIN_DISABLE = 0x00, ADC_SYNCIN_EPWM0SYNCOUT = 0x01, ADC_SYNCIN_EPWM1SYNCOUT = 0x02, ADC_SYNCIN_EPWM2SYNCOUT = 0x03,
  ADC_SYNCIN_EPWM3SYNCOUT = 0x04, ADC_SYNCIN_EPWM4SYNCOUT = 0x05, ADC_SYNCIN_EPWM5SYNCOUT = 0x06, ADC_SYNCIN_EPWM6SYNCOUT = 0x07,
  ADC_SYNCIN_EPWM7SYNCOUT = 0x08, ADC_SYNCIN_EPWM8SYNCOUT = 0x09, ADC_SYNCIN_EPWM9SYNCOUT = 0x0A, ADC_SYNCIN_EPWM10SYNCOUT = 0x0B,
  ADC_SYNCIN_EPWM11SYNCOUT = 0x0C, ADC_SYNCIN_EPWM12SYNCOUT = 0x0D, ADC_SYNCIN_EPWM13SYNCOUT = 0x0E, ADC_SYNCIN_EPWM14SYNCOUT = 0x0F,
  ADC_SYNCIN_EPWM15SYNCOUT = 0x10, ADC_SYNCIN_EPWM16SYNCOUT = 0x11, ADC_SYNCIN_EPWM17SYNCOUT = 0x12, ADC_SYNCIN_EPWM18SYNCOUT = 0x13,
  ADC_SYNCIN_EPWM19SYNCOUT = 0x14, ADC_SYNCIN_EPWM20SYNCOUT = 0x15, ADC_SYNCIN_EPWM21SYNCOUT = 0x16, ADC_SYNCIN_EPWM22SYNCOUT = 0x17,
  ADC_SYNCIN_EPWM23SYNCOUT = 0x18, ADC_SYNCIN_EPWM24SYNCOUT = 0x19, ADC_SYNCIN_EPWM25SYNCOUT = 0x1A, ADC_SYNCIN_EPWM26SYNCOUT = 0x1B,
  ADC_SYNCIN_EPWM27SYNCOUT = 0x1C, ADC_SYNCIN_EPWM28SYNCOUT = 0x1D, ADC_SYNCIN_EPWM29SYNCOUT = 0x1E, ADC_SYNCIN_EPWM30SYNCOUT = 0x1F,
  ADC_SYNCIN_EPWM31SYNCOUT = 0x20, ADC_SYNCIN_ECAP0SYNCOUT = 0x21, ADC_SYNCIN_ECAP1SYNCOUT = 0x22, ADC_SYNCIN_ECAP2SYNCOUT = 0x23,
  ADC_SYNCIN_ECAP3SYNCOUT = 0x24, ADC_SYNCIN_ECAP4SYNCOUT = 0x25, ADC_SYNCIN_ECAP5SYNCOUT = 0x26, ADC_SYNCIN_ECAP6SYNCOUT = 0x27,
  ADC_SYNCIN_ECAP7SYNCOUT = 0x28, ADC_SYNCIN_ECAP8SYNCOUT = 0x29, ADC_SYNCIN_ECAP9SYNCOUT = 0x2A, ADC_SYNCIN_ECAP10SYNCOUT = 0x2B,
  ADC_SYNCIN_ECAP11SYNCOUT = 0x2C, ADC_SYNCIN_ECAP12SYNCOUT = 0x2D, ADC_SYNCIN_ECAP13SYNCOUT = 0x2E, ADC_SYNCIN_ECAP14SYNCOUT = 0x2F,
  ADC_SYNCIN_ECAP15SYNCOUT = 0x30, ADC_SYNCIN_INPUTXBAROUTPUT6 = 0x31, ADC_SYNCIN_INPUTXBAROUTPUT7 = 0x32, ADC_SYNCIN_CPSW_CTPS_SYNC = 0x33
}
 
enum  ADC_PPBIntSrcSelect { ADC_PPB_OS_INT_1 = 0x0U, ADC_PPB_OS_INT_2 = 0x1U }
 
enum  ADC_ExtChannel { ADC_CH_ADCINX_0 = 0x0, ADC_CH_ADCINX_1 = 0x1, ADC_CH_ADCINX_2 = 0x2, ADC_CH_ADCINX_3 = 0x3 }
 
enum  ADC_IntTrigger {
  ADC_INT_TRIGGER_EOC0 = 0, ADC_INT_TRIGGER_EOC1 = 1, ADC_INT_TRIGGER_EOC2 = 2, ADC_INT_TRIGGER_EOC3 = 3,
  ADC_INT_TRIGGER_EOC4 = 4, ADC_INT_TRIGGER_EOC5 = 5, ADC_INT_TRIGGER_EOC6 = 6, ADC_INT_TRIGGER_EOC7 = 7,
  ADC_INT_TRIGGER_EOC8 = 8, ADC_INT_TRIGGER_EOC9 = 9, ADC_INT_TRIGGER_EOC10 = 10, ADC_INT_TRIGGER_EOC11 = 11,
  ADC_INT_TRIGGER_EOC12 = 12, ADC_INT_TRIGGER_EOC13 = 13, ADC_INT_TRIGGER_EOC14 = 14, ADC_INT_TRIGGER_EOC15 = 15,
  ADC_INT_TRIGGER_OSINT1 = 16, ADC_INT_TRIGGER_OSINT2 = 17, ADC_INT_TRIGGER_OSINT3 = 18, ADC_INT_TRIGGER_OSINT4 = 19
}
 
enum  ADC_PPBCompSource { ADC_PPB_COMPSOURCE_RESULT = 0x0, ADC_PPB_COMPSOURCE_PSUM = 0x1, ADC_PPB_COMPSOURCE_SUM = 0x2 }
 
enum  ADC_Select {
  ADC_0 = 0, ADC_1 = 1, ADC_2 = 2, ADC_3 = 3,
  ADC_4 = 4
}
 
enum  ADC_ResultSelect {
  ADC_RESULT0 = 0, ADC_RESULT1 = 1, ADC_RESULT2 = 2, ADC_RESULT3 = 3,
  ADC_RESULT4 = 4, ADC_RESULT5 = 5, ADC_RESULT6 = 6, ADC_RESULT7 = 7,
  ADC_RESULT8 = 8, ADC_RESULT9 = 9, ADC_RESULT10 = 10, ADC_RESULT11 = 11,
  ADC_RESULT12 = 12, ADC_RESULT13 = 13, ADC_RESULT14 = 14, ADC_RESULT15 = 15
}
 
enum  ADC_SafetyCheckerInput { ADC_SAFETY_CHECKER_INPUT_DISABLE = 0x0, ADC_SAFETY_CHECKER_INPUT_SOCx = 0x1, ADC_SAFETY_CHECKER_INPUT_PPBx = 0x2, ADC_SAFETY_CHECKER_INPUT_PPBSUMx = 0x3 }
 
enum  ADC_SafetyCheckInst { ADC_SAFETY_CHECK1 = 0x0, ADC_SAFETY_CHECK2 = 0x4 }
 
enum  ADC_SafetyCheckEvent { ADC_SAFETY_CHECK_EVENT1 = 0, ADC_SAFETY_CHECK_EVENT2 = 16, ADC_SAFETY_CHECK_EVENT3 = 32, ADC_SAFETY_CHECK_EVENT4 = 48 }
 
enum  ADC_SafetyCheckResult { ADC_SAFETY_CHECK_RES1OVF = 0, ADC_SAFETY_CHECK_RES2OVF = 4, ADC_SAFETY_CHECK_OOT = 8 }
 
enum  ADC_Checker {
  ADC_SAFETY_CHECKER1 = 0, ADC_SAFETY_CHECKER2 = 1, ADC_SAFETY_CHECKER3 = 2, ADC_SAFETY_CHECKER4 = 3,
  ADC_SAFETY_CHECKER5 = 4, ADC_SAFETY_CHECKER6 = 5, ADC_SAFETY_CHECKER7 = 6, ADC_SAFETY_CHECKER8 = 7,
  ADC_SAFETY_CHECKER9 = 8, ADC_SAFETY_CHECKER10 = 9, ADC_SAFETY_CHECKER11 = 10, ADC_SAFETY_CHECKER12 = 11
}
 
enum  ADC_SafetyCheckFlag { ADC_SAFETY_CHECK_OOT_FLG = 0, ADC_SAFETY_CHECK_RES1OVF_FLG = 4, ADC_SAFETY_CHECK_RES2OVF_FLG = 8 }
 
enum  ADC_RepInstance { ADC_REPINST1 = 0x0, ADC_REPINST2 = 0x1 }
 
enum  ADC_RepMode { ADC_REPMODE_OVERSAMPLING = 0x0, ADC_REPMODE_UNDERSAMPLING = 0x1 }
 

Macros

#define ADC_ADCSOCxCTL_STEP   (CSL_ADC_ADCSOC1CTL - CSL_ADC_ADCSOC0CTL)
 Header Files. More...
 
#define ADC_ADCSOCxCTL_STEP   (CSL_ADC_ADCSOC1CTL - CSL_ADC_ADCSOC0CTL)
 Header Files. More...
 
#define ADC_ADCINTSELxNy_STEP   (CSL_ADC_ADCINTSEL3N4 - CSL_ADC_ADCINTSEL1N2)
 Register offset difference between 2 ADCINTSELxNy registers. More...
 
#define ADC_ADCINTSELxNy_STEP   (CSL_ADC_ADCINTSEL3N4 - CSL_ADC_ADCINTSEL1N2)
 Register offset difference between 2 ADCINTSELxNy registers. More...
 
#define ADC_ADCPPBx_STEP   (CSL_ADC_ADCPPB2CONFIG - CSL_ADC_ADCPPB1CONFIG)
 Register offset difference between 2 ADCPPBxCONFIG registers. More...
 
#define ADC_ADCPPBx_STEP   (CSL_ADC_ADCPPB2CONFIG - CSL_ADC_ADCPPB1CONFIG)
 Register offset difference between 2 ADCPPBxCONFIG registers. More...
 
#define ADC_ADCPPBTRIP_MASK
 ADC PPB Trip Mask. More...
 
#define ADC_ADCPPBTRIP_MASK
 ADC PPB Trip Mask. More...
 
#define ADC_RESULT_ADCPPBxRESULT_STEP
 Register offset difference between 2 ADCPPBxRESULT registers. More...
 
#define ADC_RESULT_ADCPPBxRESULT_STEP
 Register offset difference between 2 ADCPPBxRESULT registers. More...
 
#define ADC_RESULT_ADCRESULTx_STEP
 Register offset difference between 2 ADCRESULTx registers. More...
 
#define ADC_RESULT_ADCRESULTx_STEP
 Register offset difference between 2 ADCRESULTx registers. More...
 
#define ADC_REPCTL_MASK
 
#define ADC_ADCPPBxCONFIG2_STEP   (CSL_ADC_ADCPPB2CONFIG2 - CSL_ADC_ADCPPB1CONFIG2)
 Register offset difference between 2 ADCPPBxLIMIT registers. More...
 
#define ADC_ADCPPBxCONFIG2_STEP   (CSL_ADC_ADCPPB2CONFIG2 - CSL_ADC_ADCPPB1CONFIG2)
 Register offset difference between 2 ADCPPBxLIMIT registers. More...
 
#define ADC_REPxCTL_STEP   (CSL_ADC_REP2CTL - CSL_ADC_REP1CTL)
 
#define ADC_REPxN_STEP   (CSL_ADC_REP2N - CSL_ADC_REP1N)
 
#define ADC_REPxPHASE_STEP   (CSL_ADC_REP2PHASE - CSL_ADC_REP1PHASE)
 
#define ADC_REPxSPREAD_STEP   (CSL_ADC_REP2SPREAD - CSL_ADC_REP1SPREAD)
 
#define ADC_PPBxTRIPHI_STEP   (CSL_ADC_ADCPPB1TRIPHI - CSL_ADC_ADCPPB1TRIPHI)
 
#define ADC_PPBxTRIPLO_STEP   (CSL_ADC_ADCPPB2TRIPLO - CSL_ADC_ADCPPB1TRIPLO)
 
#define ADC_ADCPPBxLIMIT_STEP   (CSL_ADC_ADCPPB2LIMIT - CSL_ADC_ADCPPB1LIMIT)
 
#define ADC_ADCPPBxPCOUNT_STEP   (CSL_ADC_ADCPPBP2PCOUNT - CSL_ADC_ADCPPBP1PCOUNT)
 
#define ADC_ADCPPBxPSUM_STEP   (CSL_ADC_ADCPPB2PSUM - CSL_ADC_ADCPPB1PSUM)
 
#define ADC_ADCPPBxPMAX_STEP   (CSL_ADC_ADCPPB2PMAX - CSL_ADC_ADCPPB1PMAX)
 
#define ADC_ADCPPBxPMAXI_STEP   (CSL_ADC_ADCPPB2PMAXI - CSL_ADC_ADCPPB1PMAXI)
 
#define ADC_ADCPPBxPMIN_STEP   (CSL_ADC_ADCPPB2PMIN - CSL_ADC_ADCPPB1PMIN)
 
#define ADC_ADCPPBxPMINI_STEP   (CSL_ADC_ADCPPB2PMINI - CSL_ADC_ADCPPB1PMINI)
 
#define ADC_ADCPPBxTRIPLO2_STEP   (CSL_ADC_ADCPPB2TRIPLO2 - CSL_ADC_ADCPPB1TRIPLO2)
 
#define ADC_REPSTATUS_MASK
 
#define ADC_SAFECHECK_STATUS_MASK
 
#define ADC_EVT_TRIPHI   (0x0001U)
 Trip High Event. More...
 
#define ADC_EVT_TRIPLO   (0x0002U)
 Trip Low Event. More...
 
#define ADC_EVT_ZERO   (0x0004U)
 Zero Crossing Event. More...
 
#define ADC_FORCE_SOC0   (0x0001U)
 SW trigger ADC SOC 0. More...
 
#define ADC_FORCE_SOC1   (0x0002U)
 SW trigger ADC SOC 1. More...
 
#define ADC_FORCE_SOC2   (0x0004U)
 SW trigger ADC SOC 2. More...
 
#define ADC_FORCE_SOC3   (0x0008U)
 SW trigger ADC SOC 3. More...
 
#define ADC_FORCE_SOC4   (0x0010U)
 SW trigger ADC SOC 4. More...
 
#define ADC_FORCE_SOC5   (0x0020U)
 SW trigger ADC SOC 5. More...
 
#define ADC_FORCE_SOC6   (0x0040U)
 SW trigger ADC SOC 6. More...
 
#define ADC_FORCE_SOC7   (0x0080U)
 SW trigger ADC SOC 7. More...
 
#define ADC_FORCE_SOC8   (0x0100U)
 SW trigger ADC SOC 8. More...
 
#define ADC_FORCE_SOC9   (0x0200U)
 SW trigger ADC SOC 9. More...
 
#define ADC_FORCE_SOC10   (0x0400U)
 SW trigger ADC SOC 10. More...
 
#define ADC_FORCE_SOC11   (0x0800U)
 SW trigger ADC SOC 11. More...
 
#define ADC_FORCE_SOC12   (0x1000U)
 SW trigger ADC SOC 12. More...
 
#define ADC_FORCE_SOC13   (0x2000U)
 SW trigger ADC SOC 13. More...
 
#define ADC_FORCE_SOC14   (0x4000U)
 SW trigger ADC SOC 14. More...
 
#define ADC_FORCE_SOC15   (0x8000U)
 SW trigger ADC SOC 15. More...
 

Macro Definition Documentation

◆ ADC_ADCSOCxCTL_STEP [1/2]

#define ADC_ADCSOCxCTL_STEP   (CSL_ADC_ADCSOC1CTL - CSL_ADC_ADCSOC0CTL)

Header Files.

Defines used by the driver.

Defines used by the driver Register offset difference between 2 ADCSOCxCTL registers

Register offset difference between 2 ADCSOCxCTL registers

◆ ADC_ADCSOCxCTL_STEP [2/2]

#define ADC_ADCSOCxCTL_STEP   (CSL_ADC_ADCSOC1CTL - CSL_ADC_ADCSOC0CTL)

Header Files.

Defines used by the driver.

Defines used by the driver Register offset difference between 2 ADCSOCxCTL registers

Register offset difference between 2 ADCSOCxCTL registers

◆ ADC_ADCINTSELxNy_STEP [1/2]

#define ADC_ADCINTSELxNy_STEP   (CSL_ADC_ADCINTSEL3N4 - CSL_ADC_ADCINTSEL1N2)

Register offset difference between 2 ADCINTSELxNy registers.

◆ ADC_ADCINTSELxNy_STEP [2/2]

#define ADC_ADCINTSELxNy_STEP   (CSL_ADC_ADCINTSEL3N4 - CSL_ADC_ADCINTSEL1N2)

Register offset difference between 2 ADCINTSELxNy registers.

◆ ADC_ADCPPBx_STEP [1/2]

#define ADC_ADCPPBx_STEP   (CSL_ADC_ADCPPB2CONFIG - CSL_ADC_ADCPPB1CONFIG)

Register offset difference between 2 ADCPPBxCONFIG registers.

◆ ADC_ADCPPBx_STEP [2/2]

#define ADC_ADCPPBx_STEP   (CSL_ADC_ADCPPB2CONFIG - CSL_ADC_ADCPPB1CONFIG)

Register offset difference between 2 ADCPPBxCONFIG registers.

◆ ADC_ADCPPBTRIP_MASK [1/2]

#define ADC_ADCPPBTRIP_MASK
Value:
((uint32_t)CSL_ADC_ADCPPB1TRIPHI_LIMITHI_MASK \
| (uint32_t)CSL_ADC_ADCPPB1TRIPHI_HSIGN_MASK)

ADC PPB Trip Mask.

◆ ADC_ADCPPBTRIP_MASK [2/2]

#define ADC_ADCPPBTRIP_MASK
Value:
((uint32_t)CSL_ADC_ADCPPB1TRIPHI_LIMITHI_MASK \
| (uint32_t)CSL_ADC_ADCPPB1TRIPHI_HSIGN_MASK)

ADC PPB Trip Mask.

◆ ADC_RESULT_ADCPPBxRESULT_STEP [1/2]

#define ADC_RESULT_ADCPPBxRESULT_STEP
Value:
(CSL_ADC_RESULT_ADCPPB2RESULT -\
CSL_ADC_RESULT_ADCPPB1RESULT)

Register offset difference between 2 ADCPPBxRESULT registers.

◆ ADC_RESULT_ADCPPBxRESULT_STEP [2/2]

#define ADC_RESULT_ADCPPBxRESULT_STEP
Value:
(CSL_ADC_RESULT_ADCPPB2RESULT -\
CSL_ADC_RESULT_ADCPPB1RESULT)

Register offset difference between 2 ADCPPBxRESULT registers.

◆ ADC_RESULT_ADCRESULTx_STEP [1/2]

#define ADC_RESULT_ADCRESULTx_STEP
Value:
(CSL_ADC_RESULT_ADCRESULT1 - \
CSL_ADC_RESULT_ADCRESULT0)

Register offset difference between 2 ADCRESULTx registers.

◆ ADC_RESULT_ADCRESULTx_STEP [2/2]

#define ADC_RESULT_ADCRESULTx_STEP
Value:
(CSL_ADC_RESULT_ADCRESULT1 - \
CSL_ADC_RESULT_ADCRESULT0)

Register offset difference between 2 ADCRESULTx registers.

◆ ADC_REPCTL_MASK

#define ADC_REPCTL_MASK
Value:
(CSL_ADC_REP1CTL_MODE_MASK |\
CSL_ADC_REP1CTL_TRIGGER_MASK |\
CSL_ADC_REP1CTL_SYNCINSEL_MASK)

◆ ADC_ADCPPBxCONFIG2_STEP [1/2]

#define ADC_ADCPPBxCONFIG2_STEP   (CSL_ADC_ADCPPB2CONFIG2 - CSL_ADC_ADCPPB1CONFIG2)

Register offset difference between 2 ADCPPBxLIMIT registers.

◆ ADC_ADCPPBxCONFIG2_STEP [2/2]

#define ADC_ADCPPBxCONFIG2_STEP   (CSL_ADC_ADCPPB2CONFIG2 - CSL_ADC_ADCPPB1CONFIG2)

Register offset difference between 2 ADCPPBxLIMIT registers.

◆ ADC_REPxCTL_STEP

#define ADC_REPxCTL_STEP   (CSL_ADC_REP2CTL - CSL_ADC_REP1CTL)

◆ ADC_REPxN_STEP

#define ADC_REPxN_STEP   (CSL_ADC_REP2N - CSL_ADC_REP1N)

◆ ADC_REPxPHASE_STEP

#define ADC_REPxPHASE_STEP   (CSL_ADC_REP2PHASE - CSL_ADC_REP1PHASE)

◆ ADC_REPxSPREAD_STEP

#define ADC_REPxSPREAD_STEP   (CSL_ADC_REP2SPREAD - CSL_ADC_REP1SPREAD)

◆ ADC_PPBxTRIPHI_STEP

#define ADC_PPBxTRIPHI_STEP   (CSL_ADC_ADCPPB1TRIPHI - CSL_ADC_ADCPPB1TRIPHI)

◆ ADC_PPBxTRIPLO_STEP

#define ADC_PPBxTRIPLO_STEP   (CSL_ADC_ADCPPB2TRIPLO - CSL_ADC_ADCPPB1TRIPLO)

◆ ADC_ADCPPBxLIMIT_STEP

#define ADC_ADCPPBxLIMIT_STEP   (CSL_ADC_ADCPPB2LIMIT - CSL_ADC_ADCPPB1LIMIT)

◆ ADC_ADCPPBxPCOUNT_STEP

#define ADC_ADCPPBxPCOUNT_STEP   (CSL_ADC_ADCPPBP2PCOUNT - CSL_ADC_ADCPPBP1PCOUNT)

◆ ADC_ADCPPBxPSUM_STEP

#define ADC_ADCPPBxPSUM_STEP   (CSL_ADC_ADCPPB2PSUM - CSL_ADC_ADCPPB1PSUM)

◆ ADC_ADCPPBxPMAX_STEP

#define ADC_ADCPPBxPMAX_STEP   (CSL_ADC_ADCPPB2PMAX - CSL_ADC_ADCPPB1PMAX)

◆ ADC_ADCPPBxPMAXI_STEP

#define ADC_ADCPPBxPMAXI_STEP   (CSL_ADC_ADCPPB2PMAXI - CSL_ADC_ADCPPB1PMAXI)

◆ ADC_ADCPPBxPMIN_STEP

#define ADC_ADCPPBxPMIN_STEP   (CSL_ADC_ADCPPB2PMIN - CSL_ADC_ADCPPB1PMIN)

◆ ADC_ADCPPBxPMINI_STEP

#define ADC_ADCPPBxPMINI_STEP   (CSL_ADC_ADCPPB2PMINI - CSL_ADC_ADCPPB1PMINI)

◆ ADC_ADCPPBxTRIPLO2_STEP

#define ADC_ADCPPBxTRIPLO2_STEP   (CSL_ADC_ADCPPB2TRIPLO2 - CSL_ADC_ADCPPB1TRIPLO2)

◆ ADC_REPSTATUS_MASK

#define ADC_REPSTATUS_MASK
Value:
(CSL_ADC_REP1CTL_MODULEBUSY_MASK |\
CSL_ADC_REP1CTL_PHASEOVF_MASK |\
CSL_ADC_REP1CTL_TRIGGEROVF_MASK)

◆ ADC_SAFECHECK_STATUS_MASK

#define ADC_SAFECHECK_STATUS_MASK
Value:
(CSL_ADC_SAFETY_CHECKSTATUS_RES1READY_MASK|\
CSL_ADC_SAFETY_CHECKSTATUS_RES2READY_MASK|\
CSL_ADC_SAFETY_CHECKSTATUS_OOT_MASK)

◆ ADC_EVT_TRIPHI

#define ADC_EVT_TRIPHI   (0x0001U)

Trip High Event.

◆ ADC_EVT_TRIPLO

#define ADC_EVT_TRIPLO   (0x0002U)

Trip Low Event.

◆ ADC_EVT_ZERO

#define ADC_EVT_ZERO   (0x0004U)

Zero Crossing Event.

◆ ADC_FORCE_SOC0

#define ADC_FORCE_SOC0   (0x0001U)

SW trigger ADC SOC 0.

◆ ADC_FORCE_SOC1

#define ADC_FORCE_SOC1   (0x0002U)

SW trigger ADC SOC 1.

◆ ADC_FORCE_SOC2

#define ADC_FORCE_SOC2   (0x0004U)

SW trigger ADC SOC 2.

◆ ADC_FORCE_SOC3

#define ADC_FORCE_SOC3   (0x0008U)

SW trigger ADC SOC 3.

◆ ADC_FORCE_SOC4

#define ADC_FORCE_SOC4   (0x0010U)

SW trigger ADC SOC 4.

◆ ADC_FORCE_SOC5

#define ADC_FORCE_SOC5   (0x0020U)

SW trigger ADC SOC 5.

◆ ADC_FORCE_SOC6

#define ADC_FORCE_SOC6   (0x0040U)

SW trigger ADC SOC 6.

◆ ADC_FORCE_SOC7

#define ADC_FORCE_SOC7   (0x0080U)

SW trigger ADC SOC 7.

◆ ADC_FORCE_SOC8

#define ADC_FORCE_SOC8   (0x0100U)

SW trigger ADC SOC 8.

◆ ADC_FORCE_SOC9

#define ADC_FORCE_SOC9   (0x0200U)

SW trigger ADC SOC 9.

◆ ADC_FORCE_SOC10

#define ADC_FORCE_SOC10   (0x0400U)

SW trigger ADC SOC 10.

◆ ADC_FORCE_SOC11

#define ADC_FORCE_SOC11   (0x0800U)

SW trigger ADC SOC 11.

◆ ADC_FORCE_SOC12

#define ADC_FORCE_SOC12   (0x1000U)

SW trigger ADC SOC 12.

◆ ADC_FORCE_SOC13

#define ADC_FORCE_SOC13   (0x2000U)

SW trigger ADC SOC 13.

◆ ADC_FORCE_SOC14

#define ADC_FORCE_SOC14   (0x4000U)

SW trigger ADC SOC 14.

◆ ADC_FORCE_SOC15

#define ADC_FORCE_SOC15   (0x8000U)

SW trigger ADC SOC 15.

Enumeration Type Documentation

◆ ADC_ClkPrescale

Values that can be passed to ADC_setPrescaler() as the clkPrescale parameter.

Enumerator
ADC_CLK_DIV_1_0 

ADCCLK = (input clock) / 1.0.

ADC_CLK_DIV_2_0 

ADCCLK = (input clock) / 2.0.

ADC_CLK_DIV_2_5 

ADCCLK = (input clock) / 2.5.

ADC_CLK_DIV_3_0 

ADCCLK = (input clock) / 3.0.

ADC_CLK_DIV_3_5 

ADCCLK = (input clock) / 3.5.

ADC_CLK_DIV_4_0 

ADCCLK = (input clock) / 4.0.

ADC_CLK_DIV_4_5 

ADCCLK = (input clock) / 4.5.

ADC_CLK_DIV_5_0 

ADCCLK = (input clock) / 5.0.

ADC_CLK_DIV_5_5 

ADCCLK = (input clock) / 5.5.

ADC_CLK_DIV_6_0 

ADCCLK = (input clock) / 6.0.

ADC_CLK_DIV_6_5 

ADCCLK = (input clock) / 6.5.

ADC_CLK_DIV_7_0 

ADCCLK = (input clock) / 7.0.

ADC_CLK_DIV_7_5 

ADCCLK = (input clock) / 7.5.

ADC_CLK_DIV_8_0 

ADCCLK = (input clock) / 8.0.

ADC_CLK_DIV_8_5 

ADCCLK = (input clock) / 8.5.

◆ ADC_Resolution

Values that can be passed to ADC_setMode() as the resolution parameter.

Enumerator
ADC_RESOLUTION_12BIT 

12-bit conversion resolution

◆ ADC_SignalMode

Values that can be passed to ADC_setMode() as the signalMode parameter.

Enumerator
ADC_MODE_SINGLE_ENDED 

Sample on single pin with VREFLO.

ADC_MODE_DIFFERENTIAL 

Sample on pair of pins.

◆ ADC_Trigger

Values that can be passed to ADC_setupSOC() as the trigger parameter to specify the event that will trigger a conversion to start. It is also used with ADC_setBurstModeConfig().

Enumerator
ADC_TRIGGER_SW_ONLY 

Software only.

ADC_TRIGGER_RTI0 

RTI Timer 0.

ADC_TRIGGER_RTI1 

RTI Timer 1.

ADC_TRIGGER_RTI2 

RTI Timer 2.

ADC_TRIGGER_RTI3 

RTI Timer 3.

ADC_TRIGGER_INPUT_XBAR_OUT5 

InputXBar.Out[5].

ADC_TRIGGER_EPWM0_SOCA 

ePWM0, ADCSOCA

ADC_TRIGGER_EPWM0_SOCB 

ePWM0, ADCSOCB

ADC_TRIGGER_EPWM1_SOCA 

ePWM1, ADCSOCA

ADC_TRIGGER_EPWM1_SOCB 

ePWM1, ADCSOCB

ADC_TRIGGER_EPWM2_SOCA 

ePWM2, ADCSOCA

ADC_TRIGGER_EPWM2_SOCB 

ePWM2, ADCSOCB

ADC_TRIGGER_EPWM3_SOCA 

ePWM3, ADCSOCA

ADC_TRIGGER_EPWM3_SOCB 

ePWM3, ADCSOCB

ADC_TRIGGER_EPWM4_SOCA 

ePWM4, ADCSOCA

ADC_TRIGGER_EPWM4_SOCB 

ePWM4, ADCSOCB

ADC_TRIGGER_EPWM5_SOCA 

ePWM5, ADCSOCA

ADC_TRIGGER_EPWM5_SOCB 

ePWM5, ADCSOCB

ADC_TRIGGER_EPWM6_SOCA 

ePWM6, ADCSOCA

ADC_TRIGGER_EPWM6_SOCB 

ePWM6, ADCSOCB

ADC_TRIGGER_EPWM7_SOCA 

ePWM7, ADCSOCA

ADC_TRIGGER_EPWM7_SOCB 

ePWM7, ADCSOCB

ADC_TRIGGER_EPWM8_SOCA 

ePWM8, ADCSOCA

ADC_TRIGGER_EPWM8_SOCB 

ePWM8, ADCSOCB

ADC_TRIGGER_EPWM9_SOCA 

ePWM9, ADCSOCA

ADC_TRIGGER_EPWM9_SOCB 

ePWM9, ADCSOCB

ADC_TRIGGER_EPWM10_SOCA 

ePWM10, ADCSOCA

ADC_TRIGGER_EPWM10_SOCB 

ePWM10, ADCSOCB

ADC_TRIGGER_EPWM11_SOCA 

ePWM11, ADCSOCA

ADC_TRIGGER_EPWM11_SOCB 

ePWM11, ADCSOCB

ADC_TRIGGER_EPWM12_SOCA 

ePWM12, ADCSOCA

ADC_TRIGGER_EPWM12_SOCB 

ePWM12, ADCSOCB

ADC_TRIGGER_EPWM13_SOCA 

ePWM13, ADCSOCA

ADC_TRIGGER_EPWM13_SOCB 

ePWM13, ADCSOCB

ADC_TRIGGER_EPWM14_SOCA 

ePWM14, ADCSOCA

ADC_TRIGGER_EPWM14_SOCB 

ePWM14, ADCSOCB

ADC_TRIGGER_EPWM15_SOCA 

ePWM15, ADCSOCA

ADC_TRIGGER_EPWM15_SOCB 

ePWM15, ADCSOCB

ADC_TRIGGER_EPWM16_SOCA 

ePWM16, ADCSOCA

ADC_TRIGGER_EPWM16_SOCB 

ePWM16, ADCSOCB

ADC_TRIGGER_EPWM17_SOCA 

ePWM17, ADCSOCA

ADC_TRIGGER_EPWM17_SOCB 

ePWM17, ADCSOCB

ADC_TRIGGER_EPWM18_SOCA 

ePWM18, ADCSOCA

ADC_TRIGGER_EPWM18_SOCB 

ePWM18, ADCSOCB

ADC_TRIGGER_EPWM19_SOCA 

ePWM19, ADCSOCA

ADC_TRIGGER_EPWM19_SOCB 

ePWM19, ADCSOCB

ADC_TRIGGER_EPWM20_SOCA 

ePWM20, ADCSOCA

ADC_TRIGGER_EPWM20_SOCB 

ePWM20, ADCSOCB

ADC_TRIGGER_EPWM21_SOCA 

ePWM21, ADCSOCA

ADC_TRIGGER_EPWM21_SOCB 

ePWM21, ADCSOCB

ADC_TRIGGER_EPWM22_SOCA 

ePWM22, ADCSOCA

ADC_TRIGGER_EPWM22_SOCB 

ePWM22, ADCSOCB

ADC_TRIGGER_EPWM23_SOCA 

ePWM23, ADCSOCA

ADC_TRIGGER_EPWM23_SOCB 

ePWM23, ADCSOCB

ADC_TRIGGER_EPWM24_SOCA 

ePWM24, ADCSOCA

ADC_TRIGGER_EPWM24_SOCB 

ePWM24, ADCSOCB

ADC_TRIGGER_EPWM25_SOCA 

ePWM25, ADCSOCA

ADC_TRIGGER_EPWM25_SOCB 

ePWM25, ADCSOCB

ADC_TRIGGER_EPWM26_SOCA 

ePWM26, ADCSOCA

ADC_TRIGGER_EPWM26_SOCB 

ePWM26, ADCSOCB

ADC_TRIGGER_EPWM27_SOCA 

ePWM27, ADCSOCA

ADC_TRIGGER_EPWM27_SOCB 

ePWM27, ADCSOCB

ADC_TRIGGER_EPWM28_SOCA 

ePWM28, ADCSOCA

ADC_TRIGGER_EPWM28_SOCB 

ePWM28, ADCSOCB

ADC_TRIGGER_EPWM29_SOCA 

ePWM29, ADCSOCA

ADC_TRIGGER_EPWM29_SOCB 

ePWM29, ADCSOCB

ADC_TRIGGER_EPWM30_SOCA 

ePWM30, ADCSOCA

ADC_TRIGGER_EPWM30_SOCB 

ePWM30, ADCSOCB

ADC_TRIGGER_EPWM31_SOCA 

ePWM31, ADCSOCA

ADC_TRIGGER_EPWM31_SOCB 

ePWM31, ADCSOCB

ADC_TRIGGER_ECAP0_SOCEVT 

eCAP0, SOCEVT

ADC_TRIGGER_ECAP1_SOCEVT 

eCAP1, SOCEVT

ADC_TRIGGER_ECAP2_SOCEVT 

eCAP2, SOCEVT

ADC_TRIGGER_ECAP3_SOCEVT 

eCAP3, SOCEVT

ADC_TRIGGER_ECAP4_SOCEVT 

eCAP4, SOCEVT

ADC_TRIGGER_ECAP5_SOCEVT 

eCAP5, SOCEVT

ADC_TRIGGER_ECAP6_SOCEVT 

eCAP6, SOCEVT

ADC_TRIGGER_ECAP7_SOCEVT 

eCAP7, SOCEVT

ADC_TRIGGER_ECAP8_SOCEVT 

eCAP8, SOCEVT

ADC_TRIGGER_ECAP9_SOCEVT 

eCAP9, SOCEVT

ADC_TRIGGER_ECAP10_SOCEVT 

eCAP10, SOCEVT

ADC_TRIGGER_ECAP11_SOCEVT 

eCAP11, SOCEVT

ADC_TRIGGER_ECAP12_SOCEVT 

eCAP12, SOCEVT

ADC_TRIGGER_ECAP13_SOCEVT 

eCAP13, SOCEVT

ADC_TRIGGER_ECAP14_SOCEVT 

eCAP14, SOCEVT

ADC_TRIGGER_ECAP15_SOCEVT 

eCAP15, SOCEVT

ADC_TRIGGER_RTI4 

RTI Timer 4.

ADC_TRIGGER_RTI5 

RTI Timer 5.

ADC_TRIGGER_RTI6 

RTI Timer 6.

ADC_TRIGGER_RTI7 

RTI Timer 7.

ADC_TRIGGER_REPEATER1 

Repeater 1.

ADC_TRIGGER_REPEATER2 

Repeater 2.

◆ ADC_Channel

Values that can be passed to ADC_setupSOC() as the channel parameter. This is the input pin on which the signal to be converted is located.

Enumerator
ADC_CH_ADCIN0 

single-ended, ADCIN0

ADC_CH_ADCIN1 

single-ended, ADCIN1

ADC_CH_ADCIN2 

single-ended, ADCIN2

ADC_CH_ADCIN3 

single-ended, ADCIN3

ADC_CH_ADCIN4 

single-ended, ADCIN4

ADC_CH_ADCIN5 

single-ended, ADCIN5

ADC_CH_ADCIN6 

single-ended, ADCIN6 Note : only valid for AM261x

ADC_CH_CAL0 

single-ended, CAL0

ADC_CH_CAL1 

single-ended, CAL1 Note : Not Valid for AM261x

ADC_CH_ADCIN0_ADCIN1 

differential, ADCIN0 and ADCIN1

ADC_CH_ADCIN1_ADCIN0 

differential, ADCIN1 and ADCIN0

ADC_CH_ADCIN2_ADCIN3 

differential, ADCIN2 and ADCIN3

ADC_CH_ADCIN3_ADCIN2 

differential, ADCIN3 and ADCIN2

ADC_CH_ADCIN4_ADCIN5 

differential, ADCIN4 and ADCIN5

ADC_CH_ADCIN5_ADCIN4 

differential, ADCIN5 and ADCIN4

ADC_CH_CAL0_CAL1 

differential, CAL0 and CAL1 Note : Not Valid for AM261x

ADC_CH_CAL1_CAL0 

differential, CAL1 and CAL0 Note : Not Valid for AM261x

ADC_CH_CAL0_ADCIN6 

differential, CAL0 and ADCIN6 Note : only valid for AM261x

ADC_CH_ADCIN6_CAL0 

differential, ADCIN6 and CAL0 Note : only valid for AM261x

◆ ADC_PulseMode

Values that can be passed to ADC_setInterruptPulseMode() as the pulseMode parameter.

Enumerator
ADC_PULSE_END_OF_ACQ_WIN 

Occurs at the end of the acquisition window.

ADC_PULSE_END_OF_CONV 

Occurs at the end of the conversion.

◆ ADC_IntNumber

Values that can be passed to ADC_enableInterrupt(), ADC_disableInterrupt(), ADC_clearInterruptStatus(), ADC_getInterruptOverflowStatus(), ADC_clearInterruptOverflowStatus(), ADC_setInterruptSource(), ADC_enableContinuousMode(), ADC_disableContinuousMode() and ADC_getInterruptStatus() as the adcIntNum parameter.

Enumerator
ADC_INT_NUMBER1 

ADCINT1 Interrupt.

ADC_INT_NUMBER2 

ADCINT2 Interrupt.

ADC_INT_NUMBER3 

ADCINT3 Interrupt.

ADC_INT_NUMBER4 

ADCINT4 Interrupt.

◆ ADC_PPBNumber

Values that can be passed in as the ppbNumber parameter for several functions.

Enumerator
ADC_PPB_NUMBER1 

Post-processing block 1.

ADC_PPB_NUMBER2 

Post-processing block 2.

ADC_PPB_NUMBER3 

Post-processing block 3.

ADC_PPB_NUMBER4 

Post-processing block 4.

◆ ADC_SOCNumber

Values that can be passed in as the socNumber parameter for several functions. This value identifies the start-of-conversion (SOC) that a function is configuring or accessing. Note that in some cases (for example, ADC_setInterruptSource()) socNumber is used to refer to the corresponding end-of-conversion (EOC).

Enumerator
ADC_SOC_NUMBER0 

SOC/EOC number 0.

ADC_SOC_NUMBER1 

SOC/EOC number 1.

ADC_SOC_NUMBER2 

SOC/EOC number 2.

ADC_SOC_NUMBER3 

SOC/EOC number 3.

ADC_SOC_NUMBER4 

SOC/EOC number 4.

ADC_SOC_NUMBER5 

SOC/EOC number 5.

ADC_SOC_NUMBER6 

SOC/EOC number 6.

ADC_SOC_NUMBER7 

SOC/EOC number 7.

ADC_SOC_NUMBER8 

SOC/EOC number 8.

ADC_SOC_NUMBER9 

SOC/EOC number 9.

ADC_SOC_NUMBER10 

SOC/EOC number 10.

ADC_SOC_NUMBER11 

SOC/EOC number 11.

ADC_SOC_NUMBER12 

SOC/EOC number 12.

ADC_SOC_NUMBER13 

SOC/EOC number 13.

ADC_SOC_NUMBER14 

SOC/EOC number 14.

ADC_SOC_NUMBER15 

SOC/EOC number 15.

◆ ADC_IntSOCTrigger

Values that can be passed in as the trigger parameter for the ADC_setInterruptSOCTrigger() function.

Enumerator
ADC_INT_SOC_TRIGGER_NONE 

No ADCINT will trigger the SOC.

ADC_INT_SOC_TRIGGER_ADCINT1 

ADCINT1 will trigger the SOC.

ADC_INT_SOC_TRIGGER_ADCINT2 

ADCINT2 will trigger the SOC.

◆ ADC_PriorityMode

Values that can be passed to ADC_setSOCPriority() as the priMode parameter.

Enumerator
ADC_PRI_ALL_ROUND_ROBIN 

Round robin mode is used for all.

ADC_PRI_SOC0_HIPRI 

SOC 0 hi pri, others in round robin.

ADC_PRI_THRU_SOC1_HIPRI 

SOC 0-1 hi pri, others in round robin.

ADC_PRI_THRU_SOC2_HIPRI 

SOC 0-2 hi pri, others in round robin.

ADC_PRI_THRU_SOC3_HIPRI 

SOC 0-3 hi pri, others in round robin.

ADC_PRI_THRU_SOC4_HIPRI 

SOC 0-4 hi pri, others in round robin.

ADC_PRI_THRU_SOC5_HIPRI 

SOC 0-5 hi pri, others in round robin.

ADC_PRI_THRU_SOC6_HIPRI 

SOC 0-6 hi pri, others in round robin.

ADC_PRI_THRU_SOC7_HIPRI 

SOC 0-7 hi pri, others in round robin.

ADC_PRI_THRU_SOC8_HIPRI 

SOC 0-8 hi pri, others in round robin.

ADC_PRI_THRU_SOC9_HIPRI 

SOC 0-9 hi pri, others in round robin.

ADC_PRI_THRU_SOC10_HIPRI 

SOC 0-10 hi pri, others in round robin.

ADC_PRI_THRU_SOC11_HIPRI 

SOC 0-11 hi pri, others in round robin.

ADC_PRI_THRU_SOC12_HIPRI 

SOC 0-12 hi pri, others in round robin.

ADC_PRI_THRU_SOC13_HIPRI 

SOC 0-13 hi pri, others in round robin.

ADC_PRI_THRU_SOC14_HIPRI 

SOC 0-14 hi pri, SOC15 in round robin.

ADC_PRI_ALL_HIPRI 

All priorities based on SOC number.

◆ ADC_OSDetectMode

Values that can be passed to ADC_configOSDetectMode() as the modeVal parameter.

Enumerator
ADC_OSDETECT_MODE_DISABLED 

Open/Shorts detection cir- cuit(O/S DC) is disabled

ADC_OSDETECT_MODE_VSSA 

O/S DC is enabled at zero scale

ADC_OSDETECT_MODE_VDDA 

O/S DC is enabled at full scale

ADC_OSDETECT_MODE_5BY12_VDDA 

O/S DC is enabled at 5/12 scale

ADC_OSDETECT_MODE_7BY12_VDDA 

O/S DC is enabled at 7/12 scale

ADC_OSDETECT_MODE_5K_PULLDOWN_TO_VSSA 

O/S DC is enabled at 5K pulldown to VSSA

ADC_OSDETECT_MODE_5K_PULLUP_TO_VDDA 

O/S DC is enabled at 5K pullup to VDDA

ADC_OSDETECT_MODE_7K_PULLDOWN_TO_VSSA 

O/S DC is enabled at 7K pulldown to VSSA

◆ ADC_OffsetTrim

Values that can be passed to ADC_selectOffsetTrimMode() as the mode parameter.

Enumerator
ADC_OFFSET_TRIM_COMMON 

Common Trim register for all ADC modes

ADC_OFFSET_TRIM_INDIVIDUAL 

Individual Trim registers for different ADC modes

◆ ADC_SyncInput

Enumerator
ADC_SYNCIN_DISABLE 

ADC Syncin is disabled.

ADC_SYNCIN_EPWM0SYNCOUT 

ADC Syncin is EPWM0SYNCOUT.

ADC_SYNCIN_EPWM1SYNCOUT 

ADC Syncin is EPWM1SYNCOUT.

ADC_SYNCIN_EPWM2SYNCOUT 

ADC Syncin is EPWM2SYNCOUT.

ADC_SYNCIN_EPWM3SYNCOUT 

ADC Syncin is EPWM3SYNCOUT.

ADC_SYNCIN_EPWM4SYNCOUT 

ADC Syncin is EPWM4SYNCOUT.

ADC_SYNCIN_EPWM5SYNCOUT 

ADC Syncin is EPWM5SYNCOUT.

ADC_SYNCIN_EPWM6SYNCOUT 

ADC Syncin is EPWM6SYNCOUT.

ADC_SYNCIN_EPWM7SYNCOUT 

ADC Syncin is EPWM7SYNCOUT.

ADC_SYNCIN_EPWM8SYNCOUT 

ADC Syncin is EPWM8SYNCOUT.

ADC_SYNCIN_EPWM9SYNCOUT 

ADC Syncin is EPWM9SYNCOUT.

ADC_SYNCIN_EPWM10SYNCOUT 

ADC Syncin is EPWM10SYNCOUT.

ADC_SYNCIN_EPWM11SYNCOUT 

ADC Syncin is EPWM11SYNCOUT.

ADC_SYNCIN_EPWM12SYNCOUT 

ADC Syncin is EPWM12SYNCOUT.

ADC_SYNCIN_EPWM13SYNCOUT 

ADC Syncin is EPWM13SYNCOUT.

ADC_SYNCIN_EPWM14SYNCOUT 

ADC Syncin is EPWM14SYNCOUT.

ADC_SYNCIN_EPWM15SYNCOUT 

ADC Syncin is EPWM15SYNCOUT.

ADC_SYNCIN_EPWM16SYNCOUT 

ADC Syncin is EPWM16SYNCOUT.

ADC_SYNCIN_EPWM17SYNCOUT 

ADC Syncin is EPWM17SYNCOUT.

ADC_SYNCIN_EPWM18SYNCOUT 

ADC Syncin is EPWM18SYNCOUT.

ADC_SYNCIN_EPWM19SYNCOUT 

ADC Syncin is EPWM19SYNCOUT.

ADC_SYNCIN_EPWM20SYNCOUT 

ADC Syncin is EPWM20SYNCOUT.

ADC_SYNCIN_EPWM21SYNCOUT 

ADC Syncin is EPWM21SYNCOUT.

ADC_SYNCIN_EPWM22SYNCOUT 

ADC Syncin is EPWM22SYNCOUT.

ADC_SYNCIN_EPWM23SYNCOUT 

ADC Syncin is EPWM23SYNCOUT.

ADC_SYNCIN_EPWM24SYNCOUT 

ADC Syncin is EPWM24SYNCOUT.

ADC_SYNCIN_EPWM25SYNCOUT 

ADC Syncin is EPWM25SYNCOUT.

ADC_SYNCIN_EPWM26SYNCOUT 

ADC Syncin is EPWM26SYNCOUT.

ADC_SYNCIN_EPWM27SYNCOUT 

ADC Syncin is EPWM27SYNCOUT.

ADC_SYNCIN_EPWM28SYNCOUT 

ADC Syncin is EPWM28SYNCOUT.

ADC_SYNCIN_EPWM29SYNCOUT 

ADC Syncin is EPWM29SYNCOUT.

ADC_SYNCIN_EPWM30SYNCOUT 

ADC Syncin is EPWM30SYNCOUT.

ADC_SYNCIN_EPWM31SYNCOUT 

ADC Syncin is EPWM31SYNCOUT.

ADC_SYNCIN_ECAP0SYNCOUT 

ADC Syncin is ECAP0SYNCOUT.

ADC_SYNCIN_ECAP1SYNCOUT 

ADC Syncin is ECAP1SYNCOUT.

ADC_SYNCIN_ECAP2SYNCOUT 

ADC Syncin is ECAP2SYNCOUT.

ADC_SYNCIN_ECAP3SYNCOUT 

ADC Syncin is ECAP3SYNCOUT.

ADC_SYNCIN_ECAP4SYNCOUT 

ADC Syncin is ECAP4SYNCOUT.

ADC_SYNCIN_ECAP5SYNCOUT 

ADC Syncin is ECAP5SYNCOUT.

ADC_SYNCIN_ECAP6SYNCOUT 

ADC Syncin is ECAP6SYNCOUT.

ADC_SYNCIN_ECAP7SYNCOUT 

ADC Syncin is ECAP7SYNCOUT.

ADC_SYNCIN_ECAP8SYNCOUT 

ADC Syncin is ECAP8SYNCOUT.

ADC_SYNCIN_ECAP9SYNCOUT 

ADC Syncin is ECAP9SYNCOUT.

ADC_SYNCIN_ECAP10SYNCOUT 

ADC Syncin is ECAP10SYNCOUT.

ADC_SYNCIN_ECAP11SYNCOUT 

ADC Syncin is ECAP11SYNCOUT.

ADC_SYNCIN_ECAP12SYNCOUT 

ADC Syncin is ECAP12SYNCOUT.

ADC_SYNCIN_ECAP13SYNCOUT 

ADC Syncin is ECAP13SYNCOUT.

ADC_SYNCIN_ECAP14SYNCOUT 

ADC Syncin is ECAP14SYNCOUT.

ADC_SYNCIN_ECAP15SYNCOUT 

ADC Syncin is ECAP15SYNCOUT.

ADC_SYNCIN_INPUTXBAROUTPUT6 

ADC Syncin is INPUTXBAROUTPUT6.

ADC_SYNCIN_INPUTXBAROUTPUT7 

ADC Syncin is INPUTXBAROUTPUT7.

ADC_SYNCIN_CPSW_CTPS_SYNC 

ADC Syncin is CPSW_CTPS_SYNC.

◆ ADC_PPBIntSrcSelect

Values that can be passed to ADC_selectPPBOSINTSource() as the osIntSrc parameter.

Enumerator
ADC_PPB_OS_INT_1 

PCount generates PPB interrupt.

ADC_PPB_OS_INT_2 

PCount/Sync generates PPB interrupt.

◆ ADC_ExtChannel

Values that can be passed to ADC_selectSOCExtChannel() as the extChannel parameter.

Enumerator
ADC_CH_ADCINX_0 

ADCINX.0 is converted.

ADC_CH_ADCINX_1 

ADCINX.1 is converted.

ADC_CH_ADCINX_2 

ADCINX.2 is converted.

ADC_CH_ADCINX_3 

ADCINX.3 is converted.

◆ ADC_IntTrigger

Values that can be passed to ADC_setInterruptSource() as the intTrigger parameter.

Enumerator
ADC_INT_TRIGGER_EOC0 

SOC/EOC0.

ADC_INT_TRIGGER_EOC1 

SOC/EOC1.

ADC_INT_TRIGGER_EOC2 

SOC/EOC2.

ADC_INT_TRIGGER_EOC3 

SOC/EOC3.

ADC_INT_TRIGGER_EOC4 

SOC/EOC4.

ADC_INT_TRIGGER_EOC5 

SOC/EOC5.

ADC_INT_TRIGGER_EOC6 

SOC/EOC6.

ADC_INT_TRIGGER_EOC7 

SOC/EOC7.

ADC_INT_TRIGGER_EOC8 

SOC/EOC8.

ADC_INT_TRIGGER_EOC9 

SOC/EOC9.

ADC_INT_TRIGGER_EOC10 

SOC/EOC10.

ADC_INT_TRIGGER_EOC11 

SOC/EOC11.

ADC_INT_TRIGGER_EOC12 

SOC/EOC12.

ADC_INT_TRIGGER_EOC13 

SOC/EOC13.

ADC_INT_TRIGGER_EOC14 

SOC/EOC14.

ADC_INT_TRIGGER_EOC15 

SOC/EOC15.

ADC_INT_TRIGGER_OSINT1 

OSINT1.

ADC_INT_TRIGGER_OSINT2 

OSINT2.

ADC_INT_TRIGGER_OSINT3 

OSINT3.

ADC_INT_TRIGGER_OSINT4 

OSINT4.

◆ ADC_PPBCompSource

Values that can be passed to ADC_selectPPBCompareSource() as the compSrc parameter.

Enumerator
ADC_PPB_COMPSOURCE_RESULT 

PPB compare source is ADCRESULT.

ADC_PPB_COMPSOURCE_PSUM 

PPB compare source is PSUM.

ADC_PPB_COMPSOURCE_SUM 

PPB compare source is SUM.

◆ ADC_Select

enum ADC_Select

Values that can be passed to ADC_configureSafetyChecker() as the adcInst parameter.

Enumerator
ADC_0 

Select ADC0 instance.

ADC_1 

Select ADC1 instance.

ADC_2 

Select ADC2 instance.

ADC_3 

Select ADC3 instance.

ADC_4 

Select ADC4 instance.

◆ ADC_ResultSelect

Values that can be passed to ADC_configureSafetyChecker() as the adcResultInst parameter.

Enumerator
ADC_RESULT0 

Select ADC Result 0.

ADC_RESULT1 

Select ADC Result 1.

ADC_RESULT2 

Select ADC Result 2.

ADC_RESULT3 

Select ADC Result 3.

ADC_RESULT4 

Select ADC Result 4.

ADC_RESULT5 

Select ADC Result 5.

ADC_RESULT6 

Select ADC Result 6.

ADC_RESULT7 

Select ADC Result 7.

ADC_RESULT8 

Select ADC Result 8.

ADC_RESULT9 

Select ADC Result 9.

ADC_RESULT10 

Select ADC Result 10.

ADC_RESULT11 

Select ADC Result 11.

ADC_RESULT12 

Select ADC Result 12.

ADC_RESULT13 

Select ADC Result 13.

ADC_RESULT14 

Select ADC Result 14.

ADC_RESULT15 

Select ADC Result 15.

◆ ADC_SafetyCheckerInput

Values that can be passed to ADC_configSOCSafetyCheckerInput() as the scInput parameter.

Enumerator
ADC_SAFETY_CHECKER_INPUT_DISABLE 

Safety checker i/p disabled.

ADC_SAFETY_CHECKER_INPUT_SOCx 

Safety checker i/p is SOCx.

ADC_SAFETY_CHECKER_INPUT_PPBx 

Safety checker i/p is PPBx.

ADC_SAFETY_CHECKER_INPUT_PPBSUMx 

Safety checker i/p is PPBSUMx.

◆ ADC_SafetyCheckInst

Values that can be passed to ADC_getSafetyCheckerResult() as checkInst parameter.

Enumerator
ADC_SAFETY_CHECK1 

Safety Check Result 1.

ADC_SAFETY_CHECK2 

Safety Check Result 2.

◆ ADC_SafetyCheckEvent

Values that can be passed to ADC_enableSafetyCheckEvt() and ADC_disableSafetyCheckEvt() as checkEvent parameter.

Enumerator
ADC_SAFETY_CHECK_EVENT1 

Safety Check Event 1.

ADC_SAFETY_CHECK_EVENT2 

Safety Check Event 2.

ADC_SAFETY_CHECK_EVENT3 

Safety Check Event 3.

ADC_SAFETY_CHECK_EVENT4 

Safety Check Event 4.

◆ ADC_SafetyCheckResult

Values that can be passed to ADC_enableSafetyCheckEvt(), ADC_disableSafetyCheckEvt(), ADC_enableSafetyCheckInt() and ADC_disableSafetyCheckInt() as checkResult parameter.

Enumerator
ADC_SAFETY_CHECK_RES1OVF 

Safety Check Result1 Overflow.

ADC_SAFETY_CHECK_RES2OVF 

Safety Check Result2 Overflow.

ADC_SAFETY_CHECK_OOT 

Safety Check OOT.

◆ ADC_Checker

Values that can be passed to ADC_enableSafetyCheckEvt(), ADC_disableSafetyCheckEvt(), ADC_enableSafetyCheckInt(), ADC_disableSafetyCheckInt(), ADC_getSafetyCheckStatus(), ADC_clearSafetyCheckStatus(), ADC_getSafetyCheckIntStatus() and ADC_clearSafetyCheckIntStatus() as checkerNumber parameter.

Enumerator
ADC_SAFETY_CHECKER1 

Safety Checker1.

ADC_SAFETY_CHECKER2 

Safety Checker2.

ADC_SAFETY_CHECKER3 

Safety Checker3.

ADC_SAFETY_CHECKER4 

Safety Checker4.

ADC_SAFETY_CHECKER5 

Safety Checker5.

ADC_SAFETY_CHECKER6 

Safety Checker6.

ADC_SAFETY_CHECKER7 

Safety Checker7.

ADC_SAFETY_CHECKER8 

Safety Checker8.

ADC_SAFETY_CHECKER9 

Safety Checker9.

ADC_SAFETY_CHECKER10 

Safety Checker10.

ADC_SAFETY_CHECKER11 

Safety Checker11.

ADC_SAFETY_CHECKER12 

Safety Checker12.

◆ ADC_SafetyCheckFlag

Values that can be passed to ADC_getSafetyCheckStatus() and ADC_clearSafetyCheckStatus(), as checkerFlag parameter.

Enumerator
ADC_SAFETY_CHECK_OOT_FLG 

Safety Check Out-of-Tolerance Flag.

ADC_SAFETY_CHECK_RES1OVF_FLG 

Safety Check Result1 Overflow Flag.

ADC_SAFETY_CHECK_RES2OVF_FLG 

Safety Check Result2 Overflow Flag.

◆ ADC_RepInstance

Values that can be passed to ADC_configureRepeater() as the repInstance parameter.

Enumerator
ADC_REPINST1 

Select ADC repeater instance 1.

ADC_REPINST2 

Select ADC repeater instance 2.

◆ ADC_RepMode

Values that can be passed to ADC_configureRepeater() as the config.repMode and ADC_triggerRepeaterMode() as mode parameter.

Enumerator
ADC_REPMODE_OVERSAMPLING 

ADC repeater mode is oversampling.

ADC_REPMODE_UNDERSAMPLING 

ADC repeater mode is undersampling.

Function Documentation

◆ ADC_setPrescaler()

static void ADC_setPrescaler ( uint32_t  base,
ADC_ClkPrescale  clkPrescale 
)
inlinestatic

Configures the analog-to-digital converter module prescaler.

Parameters
baseis the base address of the ADC module.
clkPrescaleis the ADC clock prescaler.

This function configures the ADC module's ADCCLK.

The clkPrescale parameter specifies the value by which the input clock is divided to make the ADCCLK. The clkPrescale value can be specified with any of the following variables: ADC_CLK_DIV_1_0, ADC_CLK_DIV_2_0, ADC_CLK_DIV_2_5, ..., ADC_CLK_DIV_7_5, ADC_CLK_DIV_8_0, or ADC_CLK_DIV_8_5.

Returns
None.

◆ ADC_setupSOC()

static void ADC_setupSOC ( uint32_t  base,
ADC_SOCNumber  socNumber,
ADC_Trigger  trigger,
ADC_Channel  channel,
uint32_t  sampleWindow 
)
inlinestatic

Configures a start-of-conversion (SOC) in the ADC.

Parameters
baseis the base address of the ADC module.
socNumberis the number of the start-of-conversion.
triggerthe source that will cause the SOC.
channelis the number associated with the input signal.
sampleWindowis the acquisition window duration.

This function configures the a start-of-conversion (SOC) in the ADC module.

The socNumber number is a value ADC_SOC_NUMBERX where X is a number from 0 to 15 specifying which SOC is to be configured on the ADC module specified by base.

The trigger specifies the event that causes the SOC such as software, a timer interrupt, an ePWM event, or an ADC interrupt. It should be a value in the format of ADC_TRIGGER_XXXX where XXXX is the event such as ADC_TRIGGER_SW_ONLY, ADC_TRIGGER_EPWM1_SOCA, and so on.

The channel parameter specifies the channel to be converted. In single-ended mode this is a single pin given by ADC_CH_ADCINx where x is the number identifying the pin between 0 and 5 inclusive. In differential mode, two pins are used as inputs and are passed in the channel parameter as ADC_CH_ADCIN0_ADCIN1, ADC_CH_ADCIN2_ADCIN3, ..., or ADC_CH_ADCIN14_ADCIN5.

The sampleWindow parameter is the acquisition window duration in SYSCLK cycles. It should be a value between 1 and 512 cycles inclusive. The selected duration must be at least as long as one ADCCLK cycle. Also, the datasheet will specify a minimum window duration requirement in nanoseconds.

Returns
None.

◆ ADC_selectSOCExtChannel()

static void ADC_selectSOCExtChannel ( uint32_t  base,
ADC_SOCNumber  socNumber,
uint16_t  extChannel 
)
inlinestatic

Configures the external channel mux for an ADC SOC.

Parameters
baseis the base address of the ADC module.
socNumberis the number of the start-of-conversion.
extChannelis the desired external channel.

This function configures the external channel for an SOC by configuring the external channel mux for an SOC.

The socNumber number is a value ADC_SOC_NUMBERX where X is a number from 0 to 15 specifying which SOC is to be configured on the ADC module specified by base.

The extChannel is the desired external channel. Valid values can be refered from the enum ADC_ExtChannel.

Returns
None.

◆ ADC_forceRepeaterTrigger()

static void ADC_forceRepeaterTrigger ( uint32_t  base,
uint16_t  repInstance 
)
inlinestatic

Forces software trigger to ADC trigger repeater block

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance to be triggered.

This function forces the selected ADC repeater block.

Valid values for repInstance parameter can be any of the individual ADC_REPEATER_INSTANCEx values defined by enum ADC_RepInstance.

Returns
None.

◆ ADC_getRepeaterStatus()

static uint16_t ADC_getRepeaterStatus ( uint32_t  base,
uint16_t  repInstance 
)
inlinestatic

Gets the current status for repeater block.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance

This function returns the current status for the repeater block.

Returns
Returns the current event status, enumerated as a bit field of CSL_ADC_REP1CTL_MODULEBUSY_MASK, CSL_ADC_REP1CTL_PHASEOVF_MASK, and CSL_ADC_REP1CTL_TRIGGEROVF_MASK.

◆ ADC_setInterruptSOCTrigger()

static void ADC_setInterruptSOCTrigger ( uint32_t  base,
ADC_SOCNumber  socNumber,
ADC_IntSOCTrigger  trigger 
)
inlinestatic

Configures the interrupt SOC trigger of an SOC.

Parameters
baseis the base address of the ADC module.
socNumberis the number of the start-of-conversion.
triggerthe interrupt source that will cause the SOC.

This function configures the interrupt start-of-conversion trigger in the ADC module.

The socNumber number is a value ADC_SOC_NUMBERX where X is a number from 0 to 15 specifying which SOC is to be configured on the ADC module specified by base.

The trigger specifies the interrupt that causes a start of conversion or none. It should be one of the following values.

  • ADC_INT_SOC_TRIGGER_NONE
  • ADC_INT_SOC_TRIGGER_ADCINT1
  • ADC_INT_SOC_TRIGGER_ADCINT2

This functionality is useful for creating continuous conversions.

Returns
None.

◆ ADC_setInterruptPulseMode()

static void ADC_setInterruptPulseMode ( uint32_t  base,
ADC_PulseMode  pulseMode 
)
inlinestatic

Sets the timing of the end-of-conversion pulse

Parameters
baseis the base address of the ADC module.
pulseModeis the generation mode of the EOC pulse.

This function configures the end-of-conversion (EOC) pulse generated by ADC. This pulse will be generated either at the end of the acquisition window plus a number of SYSCLK cycles configured by ADC_setInterruptCycleOffset() (pass ADC_PULSE_END_OF_ACQ_WIN into pulseMode) or at the end of the voltage conversion, one cycle prior to the ADC result latching into it's result register (pass ADC_PULSE_END_OF_CONV into pulseMode).

Returns
None.

◆ ADC_setInterruptCycleOffset()

static void ADC_setInterruptCycleOffset ( uint32_t  base,
uint16_t  cycleOffset 
)
inlinestatic

Sets the timing of early interrupt generation.

Parameters
baseis the base address of the ADC module.
cycleOffsetis the cycles from an SOC falling edge to an early interrupt pulse.

This function configures cycle offset between the negative edge of a sample pulse and an early interrupt pulse being generated. This number of cycles is specified with the cycleOffset parameter.

This function only applies when early interrupt generation is enabled. That means the ADC_setInterruptPulseMode() function pulseMode parameter is configured as ADC_PULSE_END_OF_ACQ_WIN.

Returns
None.

◆ ADC_enableAltDMATiming()

static void ADC_enableAltDMATiming ( uint32_t  base)
inlinestatic

Enables alternate timings for DMA trigger

Parameters
baseis the base address of the ADC module.

This function enables the alternate timings(tDMA) for DMA trigger. When enabled the DMA is always triggered at tDMA regardless of whether the ADC is in early interrupt mode or late interrupt mode.

Returns
None.

◆ ADC_disableAltDMATiming()

static void ADC_disableAltDMATiming ( uint32_t  base)
inlinestatic

Disables alternate timings for DMA trigger

Parameters
baseis the base address of the ADC module.

This function disables the alternate timings(tDMA) for DMA trigger. When disabled the DMA is triggered at the same time as the CPU interrupt.

Returns
None.

◆ ADC_enableExtMuxPreselect()

static void ADC_enableExtMuxPreselect ( uint32_t  base)
inlinestatic

Enables external channel mux preselection

Parameters
baseis the base address of the ADC module.

This function enables the preselection of external mux pins which is at the end of the S+H window of the previous conversion. This preselection allows some of the external mux settling time to be pipelined with previous conversion's conversion time and can be enabled if ADC SOC sequence is deterministic.

Returns
None.

◆ ADC_disableExtMuxPreselect()

static void ADC_disableExtMuxPreselect ( uint32_t  base)
inlinestatic

Disables external mux preselection

Parameters
baseis the base address of the ADC module.

This function disables the preselection of external mux pins as in ADCEXTMUX pins can only change at the beginning of S+H window of current conversion.

Returns
None.

◆ ADC_selectOffsetTrimMode()

static void ADC_selectOffsetTrimMode ( uint32_t  base,
ADC_OffsetTrim  mode 
)
inlinestatic

Selects the offset trim mode

Parameters
baseis the base address of the ADC module.
modeis the offset trim mode to be selected.

This function configures the offset trim mode for an ADC instance. This means that the offset trim to be used for an ADC mode would be specified by the mode parameter. Valid values for mode parameter are:

  • ADC_OFFSET_TRIM_COMMON - Offset trim will always be supplied from ADCOFFTRIM.OFFTRIM register field (Legacy mode)
  • ADC_OFFSET_TRIM_INDIVIDUAL - offset trim will be supplied from individual registers based on the combination of resolution, signalmode, and capacitor bank related configurations.
Returns
None.

◆ ADC_getIntResultStatus()

static bool ADC_getIntResultStatus ( uint32_t  base,
ADC_IntNumber  adcIntNum 
)
inlinestatic

Gets the result ready status for ADC interrupt.

Parameters
baseis the base address of the ADC module.
adcIntNumis interrupt number within the ADC wrapper.

This function returns the result ready status associated with the selected interrupt number within the ADC wrapper.

adcIntNum takes a one of the values ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3 or ADC_INT_NUMBER4 to get the result ready status for the conversions associated with the given interrupt number.

Returns
true if the result is available for the selected interrupt and false if it is not.

◆ ADC_enableConverter()

static void ADC_enableConverter ( uint32_t  base)
inlinestatic

Powers up the analog-to-digital converter core.

Parameters
baseis the base address of the ADC module.

This function powers up the analog circuitry inside the analog core.

Note
Allow at least a 500us delay before sampling after calling this API. If you enable multiple ADCs, you can delay after they all have begun powering up.
Returns
None.

◆ ADC_disableConverter()

static void ADC_disableConverter ( uint32_t  base)
inlinestatic

Powers down the analog-to-digital converter module.

Parameters
baseis the base address of the ADC module.

This function powers down the analog circuitry inside the analog core.

Returns
None.

◆ ADC_forceSOC()

static void ADC_forceSOC ( uint32_t  base,
ADC_SOCNumber  socNumber 
)
inlinestatic

Forces a SOC flag to a 1 in the analog-to-digital converter.

Parameters
baseis the base address of the ADC module.
socNumberis the number of the start-of-conversion.

This function forces the SOC flag associated with the SOC specified by socNumber. This initiates a conversion once that SOC is given priority. This software trigger can be used whether or not the SOC has been configured to accept some other specific trigger.

Returns
None.

◆ ADC_forceMultipleSOC()

static void ADC_forceMultipleSOC ( uint32_t  base,
uint16_t  socMask 
)
inlinestatic

Forces multiple SOC flags to 1 in the analog-to-digital converter.

Parameters
baseis the base address of the ADC module.
socMaskis the SOCs to be forced through software

This function forces the SOCFRC1 flags associated with the SOCs specified by socMask. This initiates a conversion once the desired SOCs are given priority. This software trigger can be used whether or not the SOC has been configured to accept some other specific trigger. Valid values for socMask parameter can be any of the individual ADC_FORCE_SOCx values or any of their OR'd combination to trigger multiple SOCs.

Note
To trigger SOC0, SOC1 and SOC2, value (ADC_FORCE_SOC0 | ADC_FORCE_SOC1 | ADC_FORCE_SOC2) should be passed as socMask.
Returns
None.

◆ ADC_getInterruptStatus()

static bool ADC_getInterruptStatus ( uint32_t  base,
ADC_IntNumber  adcIntNum 
)
inlinestatic

Gets the current ADC interrupt status.

Parameters
baseis the base address of the ADC module.
adcIntNumis interrupt number within the ADC wrapper.

This function returns the interrupt status for the analog-to-digital converter.

adcIntNum takes a one of the values ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3, or ADC_INT_NUMBER4 to express which of the four interrupts of the ADC module should be cleared.

Returns
true if the interrupt flag for the specified interrupt number is set and false if it is not.

◆ ADC_clearInterruptStatus()

static void ADC_clearInterruptStatus ( uint32_t  base,
ADC_IntNumber  adcIntNum 
)
inlinestatic

Clears ADC interrupt sources.

Parameters
baseis the base address of the ADC module.
adcIntNumis interrupt number within the ADC wrapper.

This function clears the specified ADC interrupt sources so that they no longer assert. If not in continuous mode, this function must be called before any further interrupt pulses may occur.

adcIntNum takes a one of the values ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3, or ADC_INT_NUMBER4 to express which of the four interrupts of the ADC module should be cleared.

Returns
None.

◆ ADC_getInterruptOverflowStatus()

static bool ADC_getInterruptOverflowStatus ( uint32_t  base,
ADC_IntNumber  adcIntNum 
)
inlinestatic

Gets the current ADC interrupt overflow status.

Parameters
baseis the base address of the ADC module.
adcIntNumis interrupt number within the ADC wrapper.

This function returns the interrupt overflow status for the analog-to-digital converter. An overflow condition is generated irrespective of the continuous mode.

adcIntNum takes a one of the values ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3, or ADC_INT_NUMBER4 to express which of the four interrupts of the ADC module should be cleared.

Returns
true if the interrupt overflow flag for the specified interrupt number is set and false if it is not.

◆ ADC_clearInterruptOverflowStatus()

static void ADC_clearInterruptOverflowStatus ( uint32_t  base,
ADC_IntNumber  adcIntNum 
)
inlinestatic

Clears ADC interrupt overflow sources.

Parameters
baseis the base address of the ADC module.
adcIntNumis interrupt number within the ADC wrapper.

This function clears the specified ADC interrupt overflow sources so that they no longer assert. If software tries to clear the overflow in the same cycle that hardware tries to set the overflow, then hardware has priority.

adcIntNum takes a one of the values ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3, or ADC_INT_NUMBER4 to express which of the four interrupts of the ADC module should be cleared.

Returns
None.

◆ ADC_readResult()

static uint16_t ADC_readResult ( uint32_t  resultBase,
ADC_SOCNumber  socNumber 
)
inlinestatic

Reads the conversion result.

Parameters
resultBaseis the base address of the ADC results.
socNumberis the number of the start-of-conversion.

This function returns the conversion result that corresponds to the base address passed into resultBase and the SOC passed into socNumber.

The socNumber number is a value ADC_SOC_NUMBERX where X is a number from 0 to 15 specifying which SOC's result is to be read.

Note
Take care that you are using a base address for the result registers (ADCxRESULT_BASE) and not a base address for the control registers.
Returns
Returns the conversion result.

◆ ADC_isBusy()

static bool ADC_isBusy ( uint32_t  base)
inlinestatic

Determines whether the ADC is busy or not.

Parameters
baseis the base address of the ADC.

This function allows the caller to determine whether or not the ADC is busy and can sample another channel.

Returns
Returns true if the ADC is sampling or false if all samples are complete.

◆ ADC_setBurstModeConfig()

static void ADC_setBurstModeConfig ( uint32_t  base,
ADC_Trigger  trigger,
uint16_t  burstSize 
)
inlinestatic

Set SOC burst mode.

Parameters
baseis the base address of the ADC.
triggerthe source that will cause the burst conversion sequence.
burstSizeis the number of SOCs converted during a burst sequence.

This function configures the burst trigger and burstSize of an ADC module. Burst mode allows a single trigger to walk through the round-robin SOCs one or more at a time. When burst mode is enabled, the trigger selected by the ADC_setupSOC() API will no longer have an effect on the SOCs in round-robin mode. Instead, the source specified through the trigger parameter will cause a burst of burstSize conversions to occur.

The trigger parameter takes the same values as the ADC_setupSOC() API The burstSize parameter should be a value between 1 and 16 inclusive.

Returns
None.

◆ ADC_enableBurstMode()

static void ADC_enableBurstMode ( uint32_t  base)
inlinestatic

Enables SOC burst mode.

Parameters
baseis the base address of the ADC.

This function enables SOC burst mode operation of the ADC. Burst mode allows a single trigger to walk through the round-robin SOCs one or more at a time. When burst mode is enabled, the trigger selected by the ADC_setupSOC() API will no longer have an effect on the SOCs in round-robin mode. Use ADC_setBurstMode() to configure the burst trigger and size.

Returns
None.

◆ ADC_disableBurstMode()

static void ADC_disableBurstMode ( uint32_t  base)
inlinestatic

Disables SOC burst mode.

Parameters
baseis the base address of the ADC.

This function disables SOC burst mode operation of the ADC. SOCs in round-robin mode will be triggered by the trigger configured using the ADC_setupSOC() API.

Returns
None.

◆ ADC_setSOCPriority()

static void ADC_setSOCPriority ( uint32_t  base,
ADC_PriorityMode  priMode 
)
inlinestatic

Sets the priority mode of the SOCs.

Parameters
baseis the base address of the ADC.
priModeis the priority mode of the SOCs.

This function sets the priority mode of the SOCs. There are three main modes that can be passed in the priMode parameter

  • All SOCs are in round-robin mode. This means no SOC has an inherent higher priority over another. This is selected by passing in the value ADC_PRI_ALL_ROUND_ROBIN.
  • All priorities are in high priority mode. This means that the priority of the SOC is determined by its SOC number. This option is selected by passing in the value ADC_PRI_ALL_HIPRI.
  • A range of SOCs are assigned high priority, with all others in round robin mode. High priority mode means that an SOC with high priority will interrupt the round robin wheel and insert itself as the next conversion. Passing in the value ADC_PRI_SOC0_HIPRI will make SOC0 highest priority, ADC_PRI_THRU_SOC1_HIPRI will put SOC0 and SOC 1 in high priority, and so on up to ADC_PRI_THRU_SOC14_HIPRI where SOCs 0 through 14 are in high priority.
Returns
None.

◆ ADC_configOSDetectMode()

static void ADC_configOSDetectMode ( uint32_t  base,
ADC_OSDetectMode  modeVal 
)
inlinestatic

Configures Open/Shorts Detection Circuit Mode.

Parameters
baseis the base address of the ADC.
modeValis the desired open/shorts detection circuit mode.

This function configures the open/shorts detection circuit mode of the ADC.

Returns
None.

◆ ADC_setupPPB()

static void ADC_setupPPB ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
ADC_SOCNumber  socNumber 
)
inlinestatic

Configures a post-processing block (PPB) in the ADC.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
socNumberis the number of the start-of-conversion.

This function associates a post-processing block with a SOC.

The ppbNumber is a value ADC_PPB_NUMBERX where X is a value from 1 to 4 inclusive that identifies a PPB to be configured. The socNumber number is a value ADC_SOC_NUMBERX where X is a number from 0 to 15 specifying which SOC is to be configured on the ADC module specified by base.

Note
You can have more that one PPB associated with the same SOC, but a PPB can only be configured to correspond to one SOC at a time. Also note that when you have multiple PPBs for the same SOC, the calibration offset that actually gets applied will be that of the PPB with the highest number. Since SOC0 is the default for all PPBs, look out for unintentional overwriting of a lower numbered PPB's offset.
Returns
None.

◆ ADC_enablePPBEvent()

static void ADC_enablePPBEvent ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  evtFlags 
)
inlinestatic

Enables individual ADC PPB event sources.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
evtFlagsis a bit mask of the event sources to be enabled.

This function enables the indicated ADC PPB event sources. This will allow the specified events to propagate through the X-BAR to a pin or to an ePWM module.

Returns
None.

◆ ADC_disablePPBEvent()

static void ADC_disablePPBEvent ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  evtFlags 
)
inlinestatic

Disables individual ADC PPB event sources.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
evtFlagsis a bit mask of the event sources to be enabled.

This function disables the indicated ADC PPB event sources. This will stop the specified events from propagating through the X-BAR to other modules.

Returns
None.

◆ ADC_enablePPBEventInterrupt()

static void ADC_enablePPBEventInterrupt ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  intFlags 
)
inlinestatic

Enables individual ADC PPB event interrupt sources.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
intFlagsis a bit mask of the interrupt sources to be enabled.

This function enables the indicated ADC PPB interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt. Disabled sources have no effect on the processor.

Returns
None.

◆ ADC_disablePPBEventInterrupt()

static void ADC_disablePPBEventInterrupt ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  intFlags 
)
inlinestatic

Disables individual ADC PPB event interrupt sources.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
intFlagsis a bit mask of the interrupt source to be disabled.

This function disables the indicated ADC PPB interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt. Disabled sources have no effect on the processor.

Returns
None.

◆ ADC_getPPBEventStatus()

static uint16_t ADC_getPPBEventStatus ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Gets the current ADC event status.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function returns the event status for the analog-to-digital converter.

Returns
Returns the current event status

◆ ADC_clearPPBEventStatus()

static void ADC_clearPPBEventStatus ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  evtFlags 
)
inlinestatic

Clears ADC event flags.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
evtFlagsis a bit mask of the event source to be cleared.

This function clears the indicated ADC PPB event flags. After an event occurs this function must be called to allow additional events to be produced.

Returns
None.

◆ ADC_enablePPBEventCBCClear()

static void ADC_enablePPBEventCBCClear ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Enables cycle-by-cycle clear of ADC PPB event flags.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function enables the automatic cycle-by-cycle clear of ADC PPB event flags. When enabled, the desired PPB event flags are automatically cleared on the next ADCPPBxRESULT load, unless a set condition is also occurring at the same time, in which case the set takes precedence.

Returns
None.

◆ ADC_disablePPBEventCBCClear()

static void ADC_disablePPBEventCBCClear ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Disables cycle-by-cycle clear of ADC PPB event flags.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function disables the cycle-by-cycle clear of ADC PPB event flags. When disabled, the desired PPB event flags are to be cleared explicitly in software inorder to generate next set of interrupts/events.

Returns
None.

◆ ADC_setPPBCountLimit()

static void ADC_setPPBCountLimit ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  limit 
)
inlinestatic

Configures PPB count limit.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
limitis the desired PPB count limit.

This function configures the PPB oversampling count limit which defines the number of ADC conversions to accumulate before partial sum is automatically loaded to the sum registes.

Returns
None.

◆ ADC_getPPBCountLimit()

static uint16_t ADC_getPPBCountLimit ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Returns the PPB count limit.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function returns the PPB oversampling count limit which defines the number of ADC conversions to accumulate before partial sum is automatically loaded to the sum registes.

Returns
Returns the PPB count limit.

◆ ADC_readPPBPCount()

static uint16_t ADC_readPPBPCount ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the oversampled partial count from the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function returns the oversampled partial count that corresponds to the base address passed into base and the PPB passed into ppbNumber.

Returns
Returns the oversampled partial count value.

◆ ADC_readPPBPSum()

static int32_t ADC_readPPBPSum ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the oversampled partial sum from the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function returns the oversampled partial sum of PPB results that corresponds to the base address passed into base and the PPB passed into ppbNumber.

Returns
Returns the oversampled partial sum value.

◆ ADC_readPPBPMax()

static int32_t ADC_readPPBPMax ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the processed conversion result's partial maximum value from the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function returns the oversampled partial maximum that corresponds to the base address passed into base and the PPB passed into ppbNumber.

Returns
Returns the oversampled partial maximum value.

◆ ADC_readPPBPMin()

static int32_t ADC_readPPBPMin ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the processed conversion result's partial minimum value from the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function returns the oversampled partial minimum that corresponds to the base address passed into base and the PPB passed into ppbNumber.

Returns
Returns the oversampled partial minimum value.

◆ ADC_readPPBPMaxIndex()

static uint16_t ADC_readPPBPMaxIndex ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the index of the result with partial maximum value from the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function returns the index of the oversampled partial maximum value that corresponds to the base address passed into base and the PPB passed into ppbNumber.

Returns
Returns the index of the oversampled partial maximum value.

◆ ADC_readPPBPMinIndex()

static uint16_t ADC_readPPBPMinIndex ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the index of the result with partial minimum value from the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function returns the index of the oversampled partial minimum value that corresponds to the base address passed into base and the PPB passed into ppbNumber.

Returns
Returns the index of the oversampled partial minimum value.

◆ ADC_enablePPBAbsoluteValue()

static void ADC_enablePPBAbsoluteValue ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Enables absolute value capability in the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function enables the absolute value functionality in the post- processing block specified by the ppbNumber parameter. When enabled, absolute value calculation would be done on the ADC Result associated with the selected SOC. In other words, the PPB result will calculated as shown below: (ADCPPBxRESULT = abs(ADCRESULTx - ADCPPBxOFFREF))

Returns
None

◆ ADC_disablePPBAbsoluteValue()

static void ADC_disablePPBAbsoluteValue ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Disables absolute value capability in the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function disables the absolute value functionality in the post- processing block specified by the ppbNumber parameter. When disabled, absolute value calculation would be done on the ADC Result associated with the selected SOC. In other words, the PPB result will calculated as shown below: (ADCPPBxRESULT = ADCRESULTx - ADCPPBxOFFREF)

Returns
None

◆ ADC_setPPBShiftValue()

static void ADC_setPPBShiftValue ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  shiftVal 
)
inlinestatic

Configures PPB shift value.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
shiftValis the number of bits to right shift PSUM before loading to final PPB SUM.

This function configured the shift value required to right shift the PPB PSUM before loading into the final PPB SUM.

Returns
None

◆ ADC_selectPPBSyncInput()

static void ADC_selectPPBSyncInput ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  syncInput 
)
inlinestatic

Configures PPB sync input.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
syncInputis the desired sync event to transfer partial registers to final registers and reset the partial registers.

This function configures desired sync event to transfer partial registers to final registers and reset the partial registers. For valid values of syncInput refer to enum ADC_SyncInput.

Returns
None

◆ ADC_forcePPBSync()

static void ADC_forcePPBSync ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Forces PPB software sync.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function forces the software sync for the desired PPB.

Returns
None

◆ ADC_selectPPBOSINTSource()

static void ADC_selectPPBOSINTSource ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  osIntSrc 
)
inlinestatic

Configures PPB interrupt source.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
osIntSrcselects PPB interrupt source.

This function sets which oversampling event is the source of a PPB intterupt.

For valid values of osIntSrc refer to enum ADC_PPBIntSrcSelect.

Returns
None

◆ ADC_selectPPBCompareSource()

static void ADC_selectPPBCompareSource ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  compSrc 
)
inlinestatic

Configures PPB compare source.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
compSrcis the desired source to be used for zero crossing detect logic and threshold compare.

This function configures the desired source to be used for zero crossing detect logic and threshold compare. For valid values of compSrc refer to enum ADC_PPBCompSource.

Returns
None

◆ ADC_readPPBSum()

static int32_t ADC_readPPBSum ( uint32_t  resultBase,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the oversampled final sum from the PPB.

Parameters
resultBaseis the base address of the ADC results.
ppbNumberis the number of the post-processing block.

This function returns the processed sum of results that corresponds to the base address passed into resultBase and the PPB passed into ppbNumber.

Note
Take care that you are using a base address for the result registers (ADCxRESULT_BASE) and not a base address for the control registers.
Returns
Returns the oversampled final sum value.

◆ ADC_readPPBCount()

static uint32_t ADC_readPPBCount ( uint32_t  resultBase,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the oversampled final count from the PPB.

Parameters
resultBaseis the base address of the ADC results.
ppbNumberis the number of the post-processing block.

This function returns the oversampled final count that corresponds to the base address passed into resultBase and the PPB passed into ppbNumber.

Note
Take care that you are using a base address for the result registers (ADCxRESULT_BASE) and not a base address for the control registers.
Returns
Returns the oversampled final count value.

◆ ADC_readPPBMax()

static int32_t ADC_readPPBMax ( uint32_t  resultBase,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the processed conversion result's maximum value from the PPB.

Parameters
resultBaseis the base address of the ADC results.
ppbNumberis the number of the post-processing block.

This function returns the oversampled final maximum that corresponds to the base address passed into resultBase and the PPB passed into ppbNumber.

Note
Take care that you are using a base address for the result registers (ADCxRESULT_BASE) and not a base address for the control registers.
Returns
Returns the oversampled final maximum value.

◆ ADC_readPPBMin()

static int32_t ADC_readPPBMin ( uint32_t  resultBase,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the processed conversion result's minimum value from the PPB.

Parameters
resultBaseis the base address of the ADC results.
ppbNumberis the number of the post-processing block.

This function returns the processed conversion result that corresponds to the base address passed into resultBase and the PPB passed into ppbNumber.

Note
Take care that you are using a base address for the result registers (ADCxRESULT_BASE) and not a base address for the control registers.
Returns
Returns the signed 32-bit conversion result.

◆ ADC_readPPBMaxIndex()

static uint16_t ADC_readPPBMaxIndex ( uint32_t  resultBase,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the index of the result with maximum value from the PPB.

Parameters
resultBaseis the base address of the ADC results.
ppbNumberis the number of the post-processing block.

This function returns the index of the processed conversion's maximum value that corresponds to the base address passed into resultBase and the PPB passed into ppbNumber.

Note
Take care that you are using a base address for the result registers (ADCxRESULT_BASE) and not a base address for the control registers.
Returns
Returns the index of the result with maximum value.

◆ ADC_readPPBMinIndex()

static uint16_t ADC_readPPBMinIndex ( uint32_t  resultBase,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the index of the result with minimum value from the PPB.

Parameters
resultBaseis the base address of the ADC results.
ppbNumberis the number of the post-processing block.

This function returns the index of the processed conversion's minimum value that corresponds to the base address passed into resultBase and the PPB passed into ppbNumber.

Note
Take care that you are using a base address for the result registers (ADCxRESULT_BASE) and not a base address for the control registers.
Returns
Returns the index of the result with final minimum value.

◆ ADC_readPPBResult()

static int32_t ADC_readPPBResult ( uint32_t  resultBase,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads the processed conversion result from the PPB.

Parameters
resultBaseis the base address of the ADC results.
ppbNumberis the number of the post-processing block.

This function returns the processed conversion result that corresponds to the base address passed into resultBase and the PPB passed into ppbNumber.

Note
Take care that you are using a base address for the result registers (ADCxRESULT_BASE) and not a base address for the control registers.
Returns
Returns the signed 32-bit conversion result.

◆ ADC_getPPBDelayTimeStamp()

static uint16_t ADC_getPPBDelayTimeStamp ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Reads sample delay time stamp from a PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function returns the sample delay time stamp. This delay is the number of system clock cycles between the SOC being triggered and when it began converting.

Returns
Returns the delay time stamp.

◆ ADC_setPPBCalibrationOffset()

static void ADC_setPPBCalibrationOffset ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
int16_t  offset 
)
inlinestatic

Sets the post processing block offset correction.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
offsetis the 10-bit signed value subtracted from ADC the output.

This function sets the PPB offset correction value. This value can be used to digitally remove any system-level offset inherent in the ADCIN circuit before it is stored in the appropriate result register. The offset parameter is subtracted from the ADC output and is a signed value from -512 to 511 inclusive. For example, when offset = 1, ADCRESULT = ADC output - 1. When offset = -512, ADCRESULT = ADC output - (-512) or ADC output + 512.

Passing a zero in to the offset parameter will effectively disable the calculation, allowing the raw ADC result to be passed unchanged into the result register.

Note
If multiple PPBs are applied to the same SOC, the offset that will be applied will be that of the PPB with the highest number.
Returns
None

◆ ADC_setPPBReferenceOffset()

static void ADC_setPPBReferenceOffset ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
uint16_t  offset 
)
inlinestatic

Sets the post processing block reference offset.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
offsetis the 12-bit unsigned value subtracted from ADC the output.

This function sets the PPB reference offset value. This can be used to either calculate the feedback error or convert a unipolar signal to bipolar by subtracting a reference value. The result will be stored in the appropriate PPB result register which can be read using ADC_readPPBResult().

Passing a zero in to the offset parameter will effectively disable the calculation and will pass the ADC result to the PPB result register unchanged.

Note
If in 12-bit mode, you may only pass a 12-bit value into the offset parameter.
Returns
None

◆ ADC_enablePPBTwosComplement()

static void ADC_enablePPBTwosComplement ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Enables two's complement capability in the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function enables two's complement in the post-processing block specified by the ppbNumber parameter. When enabled, a two's complement will be performed on the output of the offset subtraction before it is stored in the appropriate PPB result register. In other words, the PPB result will be the reference offset value minus the the ADC result value (ADCPPBxRESULT = ADCSOCxOFFREF - ADCRESULTx).

Returns
None

◆ ADC_disablePPBTwosComplement()

static void ADC_disablePPBTwosComplement ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Disables two's complement capability in the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function disables two's complement in the post-processing block specified by the ppbNumber parameter. When disabled, a two's complement will NOT be performed on the output of the offset subtraction before it is stored in the appropriate PPB result register. In other words, the PPB result will be the ADC result value minus the reference offset value (ADCPPBxRESULT = ADCRESULTx - ADCSOCxOFFREF).

Returns
None

◆ ADC_enablePPBExtendedLowLimit()

static void ADC_enablePPBExtendedLowLimit ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Enables the extended low limit in the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function enables the low limit for PPB by allowing the PPB low limit to be set by ADCPPBxTRIPLO2 register.

Returns
None

◆ ADC_disablePPBExtendedLowLimit()

static void ADC_disablePPBExtendedLowLimit ( uint32_t  base,
ADC_PPBNumber  ppbNumber 
)
inlinestatic

Disables extended low limit capability in the PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.

This function disables the low limit for PPB by allowing the PPB low limit to be set by ADCPPBxTRIPLO register.

Returns
None

◆ ADC_enableInterrupt()

static void ADC_enableInterrupt ( uint32_t  base,
ADC_IntNumber  adcIntNum 
)
inlinestatic

Enables an ADC interrupt source.

Parameters
baseis the base address of the ADC module.
adcIntNumis interrupt number within the ADC wrapper.

This function enables the indicated ADC interrupt source. Only the sources that are enabled can be reflected to the processor interrupt. Disabled sources have no effect on the processor.

adcIntNum can take the value ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3, or ADC_INT_NUMBER4 to express which of the four interrupts of the ADC module should be enabled.

Returns
None.

◆ ADC_disableInterrupt()

static void ADC_disableInterrupt ( uint32_t  base,
ADC_IntNumber  adcIntNum 
)
inlinestatic

Disables an ADC interrupt source.

Parameters
baseis the base address of the ADC module.
adcIntNumis interrupt number within the ADC wrapper.

This function disables the indicated ADC interrupt source. Only the sources that are enabled can be reflected to the processor interrupt. Disabled sources have no effect on the processor.

adcIntNum can take the value ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3, or ADC_INT_NUMBER4 to express which of the four interrupts of the ADC module should be disabled.

Returns
None.

◆ ADC_setInterruptSource()

static void ADC_setInterruptSource ( uint32_t  base,
ADC_IntNumber  adcIntNum,
uint16_t  intTrigger 
)
inlinestatic

Sets the source EOC for an analog-to-digital converter interrupt.

Parameters
baseis the base address of the ADC module.
adcIntNumis interrupt number within the ADC wrapper.
intTriggeris the interrupt source EOCx, OSINTy are used.

This function sets which conversion is the source of an ADC interrupt.

The intTrigger number is a value ADC_INT_TRIGGER_X where X specifies the interrupt trigger to be configured for the ADC module specified by base. Refer ADC_IntTrigger enum for valid values for this input.

adcIntNum can take the value ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3, or ADC_INT_NUMBER4 to express which of the four interrupts of the ADC module is being configured.

Returns
None.

◆ ADC_enableContinuousMode()

static void ADC_enableContinuousMode ( uint32_t  base,
ADC_IntNumber  adcIntNum 
)
inlinestatic

Enables continuous mode for an ADC interrupt.

Parameters
baseis the base address of the ADC.
adcIntNumis interrupt number within the ADC wrapper.

This function enables continuous mode for the ADC interrupt passed into adcIntNum. This means that pulses will be generated for the specified ADC interrupt whenever an EOC pulse is generated irrespective of whether or not the flag bit is set.

adcIntNum can take the value ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3, or ADC_INT_NUMBER4 to express which of the four interrupts of the ADC module is being configured.

Returns
None.

◆ ADC_disableContinuousMode()

static void ADC_disableContinuousMode ( uint32_t  base,
ADC_IntNumber  adcIntNum 
)
inlinestatic

Disables continuous mode for an ADC interrupt.

Parameters
baseis the base address of the ADC.
adcIntNumis interrupt number within the ADC wrapper.

This function disables continuous mode for the ADC interrupt passed into adcIntNum. This means that pulses will not be generated for the specified ADC interrupt until the corresponding interrupt flag for the previous interrupt occurrence has been cleared using ADC_clearInterruptStatus().

adcIntNum can take the value ADC_INT_NUMBER1, ADC_INT_NUMBER2, ADC_INT_NUMBER3, or ADC_INT_NUMBER4 to express which of the four interrupts of the ADC module is being configured.

Returns
None.

◆ ADC_configSOCSafetyCheckerInput()

static void ADC_configSOCSafetyCheckerInput ( uint32_t  base,
ADC_SOCNumber  socNumber,
ADC_SafetyCheckerInput  scInput 
)
inlinestatic

Configures the safety checker result for a selected SOC.

Parameters
baseis the base address of the ADC module.
socNumberis the number of the start-of-conversion.
scInputis the desired input configuration.

This function configures the safety checker input for the desired SOC.

The socNumber number is a value ADC_SOC_NUMBERX where X is a number from 0 to 15 specifying which SOC is to be configured on the ADC module specified by base.

The scInput is the desired safety checker input configuration. Valid values can be refered from the enum ADC_SafetyCheckerInput.

Returns
None.

◆ ADC_enableSafetyChecker()

static void ADC_enableSafetyChecker ( uint32_t  scBase)
inlinestatic

Enables the ADC result safety checker module.

Parameters
scBaseis the base address of the ADC Safety Checker module.

This function enables the ADC result safety checker module.

Returns
None.

◆ ADC_disableSafetyChecker()

static void ADC_disableSafetyChecker ( uint32_t  scBase)
inlinestatic

Disables the ADC result safety checker module.

Parameters
scBaseis the base address of the ADC Safety Checker module.

This function disables the ADC result safety checker module.

Returns
None.

◆ ADC_forceSafetyCheckerSync()

static void ADC_forceSafetyCheckerSync ( uint32_t  scBase)
inlinestatic

Forces the software sync for the safety checker module

Parameters
scBaseis the base address of the safety checker module.

This function forces the software sync for the safety checker module.

Returns
None.

◆ ADC_getSafetyCheckerStatus()

static uint16_t ADC_getSafetyCheckerStatus ( uint32_t  scBase)
inlinestatic

Returns the status of the safey checker module.

Parameters
scBaseis the base address of the ADC safety checker module.

This function configures the external channel for an SOC by configuring the external channel mux for an SOC.

Returns
Returns the status of the safety checker module. Valid values are any of the follwing values or any of their OR'd combination:
  • ADC_SAFECHECK_RESULT1_READY
  • ADC_SAFECHECK_RESULT2_READY
  • ADC_SAFECHECK_RESULT1_OOT

◆ ADC_configureSafetyChecker()

static void ADC_configureSafetyChecker ( uint32_t  scBase,
ADC_SafetyCheckInst  checkInst,
ADC_Select  adcInst,
ADC_ResultSelect  adcResultInst 
)
inlinestatic

Configures the safety checker module.

Parameters
scBaseis the base address of the ADC safety checker module.
checkInstis the safety checker instance to be configured.
adcInstis the desired ADC instance.
adcResultInstis the desired ADC result instance.

This function configures the selected checker instance of a safety checker instance.

The checkInst parameter can take values defined by enum ADC_SafetyCheckInst. The adcInst parameter can take values defined by enum ADC_Select. The adcResultInst parameter can take values defined by enum ADC_ResultSelect.

Returns
None.

◆ ADC_setSafetyCheckerTolerance()

static void ADC_setSafetyCheckerTolerance ( uint32_t  scBase,
uint32_t  tolerance 
)
inlinestatic

Configures the tolerance allowed between safety check results.

Parameters
scBaseis the base address of the ADC safety checker module.
toleranceis the number of the start-of-conversion.

This function configures the tolerance for the difference between check result instances of the selected safety checker instance.

Returns
None.

◆ ADC_getSafetyCheckerResult()

static uint32_t ADC_getSafetyCheckerResult ( uint32_t  scBase,
ADC_SafetyCheckInst  checkInst 
)
inlinestatic

Returns the safety check result for the selected instance.

Parameters
scBaseis the base address of the ADC safety checker module.
checkInstis the number of the start-of-conversion.

This function returns the safety check result for the selected instance.

The checkInst number is a value ADC_SAFETY_CHECKx where x is a number from 1 to 2 specifying the safety result check instances available in the safety checker instance specified by scBase.

Returns
Returns the safety checker result for the desired instance.

◆ ADC_enableSafetyCheckEvt()

static void ADC_enableSafetyCheckEvt ( uint32_t  scIntEvtBase,
ADC_Checker  checkerNumber,
ADC_SafetyCheckEvent  checkEvent,
ADC_SafetyCheckResult  checkResult 
)
inlinestatic

Enables the safety checker event sources for selected instance.

Parameters
scIntEvtBaseis the base address of ADC Safe Check INTEVT module.
checkResultis the desired ADC Safety Checker result.
checkEventis the desired event number.
checkerNumberis the number of the checker tile.

This function enables the indicated safety checker event sources.

The checkResult specifies the result of the OOT or OVF events. It should be one of the following values.

  • ADC_SAFETY_CHECK_RESULT1
  • ADC_SAFETY_CHECK_RESULT2
  • ADC_SAFETY_CHECK_OOT

The checkEvent is a value ADC_SAFETY_CHECK_EVENTx where x is a number from 1 to 4 specifying the safety check events available in the safety checker specified by scIntEvtBase.

The checkerNumber number is a value ADC_SAFETY_CHECKERx where x is a number from 1 to 8 specifying which Checker Tile is to be selected in the ADC module.

Returns
None.

◆ ADC_disableSafetyCheckEvt()

static void ADC_disableSafetyCheckEvt ( uint32_t  scIntEvtBase,
ADC_Checker  checkerNumber,
ADC_SafetyCheckEvent  checkEvent,
ADC_SafetyCheckResult  checkResult 
)
inlinestatic

Disables the safety checker event sources for selected instance.

Parameters
scIntEvtBaseis the base address of ADC Safe Check INTEVT module.
checkResultis the desired ADC Safety Checker result.
checkEventis the desired event number.
checkerNumberis the number of the checker tile.

This function disables the indicated safety checker event sources.

The checkResult specifies the result of the OOT or OVF events. It should be one of the following values.

  • ADC_SAFETY_CHECK_RESULT1
  • ADC_SAFETY_CHECK_RESULT2
  • ADC_SAFETY_CHECK_OOT

The checkEvent is a value ADC_SAFETY_CHECK_EVENTx where x is a number from 1 to 4 specifying the safety check events available in the safety checker specified by scIntEvtBase.

The checkerNumber number is a value ADC_CHECKER_NUMBERx where x is a number from 1 to 8 specifying which Checker Tile is to be selected in the ADC module.

Returns
None.

◆ ADC_enableSafetyCheckInt()

static void ADC_enableSafetyCheckInt ( uint32_t  scIntEvtBase,
ADC_Checker  checkerNumber,
ADC_SafetyCheckResult  checkResult 
)
inlinestatic

Enables the safety checker interrupt sources for selected instance.

Parameters
scIntEvtBaseis the base address of ADC Safe Check INTEVT module.
checkResultis the desired ADC Safety Checker interrupt result.
checkerNumberis the number of the checker tile.

This function enables the indicated safety checker interrupt sources.

The checkResult specifies the result of the OOT or OVF events. It should be one of the following values.

  • ADC_SAFETY_CHECK_RESULT1
  • ADC_SAFETY_CHECK_RESULT2
  • ADC_SAFETY_CHECK_OOT

The checkerNumber number is a value ADC_CHECKER_NUMBERx where x is a number from 1 to 8 specifying which Checker Tile is to be selected in the ADC module.

Returns
None.

◆ ADC_disableSafetyCheckInt()

static void ADC_disableSafetyCheckInt ( uint32_t  scIntEvtBase,
ADC_Checker  checkerNumber,
ADC_SafetyCheckResult  checkResult 
)
inlinestatic

Disables the safety checker interrupt sources for selected instance.

Parameters
scIntEvtBaseis the base address of ADC Safe Check INTEVT module.
checkResultis the desired ADC Safety Checker interrupt result.
checkerNumberis the number of the checker tile.

This function disables the indicated safety checker interrupt sources.

The checkResult specifies the result of the OOT or OVF events. It should be one of the following values.

  • ADC_SAFETY_CHECK_RESULT1
  • ADC_SAFETY_CHECK_RESULT2
  • ADC_SAFETY_CHECK_OOT

The checkerNumber number is a value ADC_CHECKER_NUMBERx where x is a number from 1 to 8 specifying which Checker Tile is to be selected in the ADC module.

Returns
None.

◆ ADC_getSafetyCheckStatus()

static bool ADC_getSafetyCheckStatus ( uint32_t  scIntEvtBase,
ADC_Checker  checkerNumber,
ADC_SafetyCheckFlag  checkerFlag 
)
inlinestatic

Get the ADC safety checker OOT and OVF event status.

Parameters
scIntEvtBaseis the base address of ADC Safe Check INTEVT module.
checkerFlagis the desired ADC Safety Checker event status.
checkerNumberis the number of the checker tile.

This function returns the event status for the OOT or OVF event.

The checkerFlag specifies the ADC safety checker event status of OOT or OVF events. It should be one of the following values.

  • ADC_SAFETY_CHECK_OOT_FLG
  • ADC_SAFETY_CHECK_RES1OVF_FLG
  • ADC_SAFETY_CHECK_RES2OVF_FLG

The checkerNumber number is a value ADC_SAFETY_CHECKERx where x is a number from 1 to 8 specifying which Checker Tile is to be selected in the ADC module specified by scIntEvtBase.

Returns
Returns the status of the safety checker event module for the selected instance.

◆ ADC_clearSafetyCheckStatus()

static void ADC_clearSafetyCheckStatus ( uint32_t  scIntEvtBase,
ADC_Checker  checkerNumber,
ADC_SafetyCheckFlag  checkerFlag 
)
inlinestatic

Clears the ADC safety checker OOT and OVF event status.

Parameters
scIntEvtBaseis the base address of ADC Safe Check INTEVT module.
checkerFlagis the desired ADC Safety Checker event status.
checkerNumberis the number of the checker tile.

This funtion clears the specified ADC Safety Checker event status so that they no longer assert.

checkerFlag takes one of the values ADC_SAFETY_CHECK_OOT_FLG, ADC_SAFETY_CHECK_RES1OVF_FLG or ADC_SAFETY_CHECK_RES2OVF_FLG to express which of the three event status of the ADC Safety Checker should be cleared.

The checkerNumber number is a value ADC_SAFETY_CHECKERx where x is a number from 1 to 8 specifying which Checker Tile is to be selected in the ADC module specified by scIntEvtBase.

Returns
None.

◆ ADC_getSafetyCheckIntStatus()

static uint32_t ADC_getSafetyCheckIntStatus ( uint32_t  scIntEvtBase)
inlinestatic

Get the ADC safety checker interrupt status.

Parameters
scIntEvtBaseis the base address of ADC Safe Check INTEVT module.

This function returns the interrupt status for the OOT or OVF event.

Returns
Returns the status of the safety checker interrupt for the selected instance.

◆ ADC_clearSafetyCheckIntStatus()

static void ADC_clearSafetyCheckIntStatus ( uint32_t  scIntEvtBase)
inlinestatic

Clears the ADC safety checker interrupt status.

Parameters
scIntEvtBaseis the base address of ADC Safe Check INTEVT module.

This funtion clears the specified ADC Safety Checker interrupt status so that they no longer assert.

Returns
None.

◆ ADC_triggerRepeaterMode()

static void ADC_triggerRepeaterMode ( uint32_t  base,
uint32_t  repInstance,
ADC_RepMode  mode 
)
inlinestatic

Configures the trigger repeater mode select.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance.
modeis the repeater mode.

This function configures desired ADC trigger repeater mode that corresponds to mode to select either oversampling or undersampling mode.

The repInstance is the repeater instance to be configured. Valid values for this parameter can be referred from the enum ADC_RepInstance.

Returns
None.

◆ ADC_triggerRepeaterActiveMode()

static bool ADC_triggerRepeaterActiveMode ( uint32_t  base,
uint32_t  repInstance 
)
inlinestatic

Get the trigger repeater active mode status.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance.

This function returns the status of the ADC trigger repeater mode for the selected repeater instance.

The repInstance is the repeater instance to be configured. Valid values for this parameter can be referred from the enum ADC_RepInstance.

Returns
Returns the status of the trigger repeater active mode.

◆ ADC_triggerRepeaterModuleBusy()

static bool ADC_triggerRepeaterModuleBusy ( uint32_t  base,
uint32_t  repInstance 
)
inlinestatic

Get the trigger repeater module busy indication.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance.

This function returns the status of the ADC trigger repeater module for the selected repeater instance.

The repInstance is the repeater instance to be configured. Valid values for this parameter can be referred from the enum ADC_RepInstance.

Returns
Returns the staus of the trigger repeater module busy.

◆ ADC_triggerRepeaterSelect()

static void ADC_triggerRepeaterSelect ( uint32_t  base,
uint16_t  repInstance,
ADC_Trigger  trigger 
)
inlinestatic

Configures the trigger source of the trigger repeater.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance.
triggerthe source to modify via oversampling or undersampling.

This function configures ADC trigger repeater by selecting the trigger source passed into trigger to modify via oversampling or undersampling.

The repInstance is the repeater instance to be configured. Valid values for this parameter can be referred from the enum ADC_RepInstance.

Returns
None.

◆ ADC_triggerRepeaterSyncIn()

static void ADC_triggerRepeaterSyncIn ( uint32_t  base,
uint16_t  repInstance,
ADC_SyncInput  syncInput 
)
inlinestatic

Configures the trigger repeater syncin source.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance.
syncInputis the desired sync event to reset all counters.

This function configures desired ADC trigger repeater sync event that corresponds to syncInput to reset all counters and any pending repeated triggers are discarded.

The repInstance is the repeater instance to be configured. Valid values for this parameter can be referred from the enum ADC_RepInstance.

Returns
None.

◆ ADC_forceRepeaterTriggerSync()

static void ADC_forceRepeaterTriggerSync ( uint32_t  base,
uint16_t  repInstance 
)
inlinestatic

Forces software sync for the trigger repeater block.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance.

This function forces the software sync for the trigger repeater block.

The repInstance is the repeater instance to be configured. Valid values for this parameter can be referred from the enum ADC_RepInstance.

Returns
None.

◆ ADC_triggerRepeaterCount()

static void ADC_triggerRepeaterCount ( uint32_t  base,
uint16_t  repInstance,
uint16_t  repCount 
)
inlinestatic

Configures the trigger repeater count.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance.
repCountis the desired trigger count to be selected.

This function indicates the number of repeated triggers passed into repCount and remaining triggers to be generated/supressed. In oversampling mode, the repCount parameter is the number of desired repeated triggers to be generated. It should be a value between 0 to 127 where (repCount + 1) triggers will be generated. For example, when repCount = 2, 3 triggers will be generated on receiving corresponding REPxCTL.TRIGSEL. In unversampling mode, the repCount parameter is the number of desired triggers to be supressed. It should be a value between 0 to 127 where 1 out of (repCount + 1) triggers received will be passed through. For Example, when repCount = 2, 1 out of 3 triggers will be generated.

The repInstance is the repeater instance to be configured. Valid values for this parameter can be referred from the enum ADC_RepInstance.

Returns
None.

◆ ADC_triggerRepeaterPhase()

static void ADC_triggerRepeaterPhase ( uint32_t  base,
uint16_t  repInstance,
uint16_t  repPhase 
)
inlinestatic

Configures the trigger repeater phase.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance.
repPhaseindicates the repeater trigger phase delay in sysclk cycles.

This function configures the phase delay that corresponds to repPhase by defining the number of sysclk to delay the selected trigger. The repPhase parameter should be a value between 0 and 65535 inclusive. For example, passing a 2 to the offset parameter will delay the trigger by 2 sysclks and passing 0 will pass through the trigger without delay.

The repInstance is the repeater instance to be configured. Valid values for this parameter can be referred from the enum ADC_RepInstance.

Returns
None.

◆ ADC_triggerRepeaterSpread()

static void ADC_triggerRepeaterSpread ( uint32_t  base,
uint16_t  repInstance,
uint16_t  repSpread 
)
inlinestatic

Configures the trigger repeater spread.

Parameters
baseis the base address of the ADC module.
repInstanceis the repeater instance.
repSpreadis the desired trigger spread in sysclk cycle.

This function configures the spread time by setting repSpread to number of sysclk desired between triggers. In oversampling mode, the repSpread parameter is the minimum number of sysclks to wait before creating the next repeated trigger to the ADC. It should be a value between 0 and 65535 inclusive. For example, passing a 2 to the offset parameter will create at least 2 sysclk time between repeated triggers.

The repInstance is the repeater instance to be configured. Valid values for this parameter can be referred from the enum ADC_RepInstance.

Returns
None.

◆ ADC_setMode()

void ADC_setMode ( uint32_t  base,
ADC_Resolution  resolution,
ADC_SignalMode  signalMode 
)

Configures the analog-to-digital converter resolution and signal mode.

Parameters
baseis the base address of the ADC module.
resolutionis the resolution of the converter (12 bits).
signalModeis the input signal mode of the converter.

This function configures the ADC module's conversion resolution and input signal mode and ensures that the corresponding trims are loaded.

The resolution parameter specifies the resolution of the conversion. It can be 12-bit specified by ADC_RESOLUTION_12BIT

The signalMode parameter specifies the signal mode. In single-ended mode, which is indicated by ADC_MODE_SINGLE_ENDED, the input voltage is sampled on a single pin referenced to VREFLO. In differential mode, which is indicated by ADC_MODE_DIFFERENTIAL, the input voltage to the converter is sampled on a pair of input pins, a positive and a negative.

Returns
None.

◆ ADC_setPPBTripLimits()

void ADC_setPPBTripLimits ( uint32_t  base,
ADC_PPBNumber  ppbNumber,
int32_t  tripHiLimit,
int32_t  tripLoLimit 
)

Sets the windowed trip limits for a PPB.

Parameters
baseis the base address of the ADC module.
ppbNumberis the number of the post-processing block.
tripHiLimitis the value is the digital comparator trip high limit.
tripLoLimitis the value is the digital comparator trip low limit.

This function sets the windowed trip limits for a PPB. These values set the digital comparator so that when one of the values is exceeded, either a high or low trip event will occur.

The ppbNumber is a value ADC_PPB_NUMBERX where X is a value from 1 to 4 inclusive that identifies a PPB to be configured.

In 12-bit mode, only bits 12:0 will be compared against bits 12:0 of the PPB result.

Returns
None.