adc_inputs.h File Reference

Detailed Description

Low level internal ADC code.

Date

Jan 14, 2013

Author

Andrey Belomutskiy, (c) 2012-2020

Definition in file adc_inputs.h.

Typedefs
using	AdcToken = uint32_t
using	AdcTockenInternal = union { AdcToken token

Enumerations
enum class	AdcChannelMode : char { Off , Slow , Fast }

Functions
float	getAnalogInputDividerCoefficient (adc_channel_e)
float	boardAdjustVoltage (float voltage, adc_channel_e hwChannel)
int	boardGetAnalogInputDiagnostic (adc_channel_e, float voltage)
bool	isAdcChannelValid (adc_channel_e hwChannel)
bool	isAdcChannelOnChip (adc_channel_e hwChannel)
bool	isAdcChannelOffChip (adc_channel_e hwChannel)
ObdCode	analogGetDiagnostic ()
void	adcInputsUpdateSubscribers (efitick_t nowNt)
AdcChannelMode	getAdcMode (adc_channel_e hwChannel)
void	initAdcInputs ()
void	printFullAdcReportIfNeeded (void)
int	getInternalAdcValue (const char *msg, adc_channel_e index)
void	addFastAdcChannel (const char *name, adc_channel_e hwChannel)
void	removeChannel (const char *name, adc_channel_e hwChannel)
struct {
uint16_t   adc
uint16_t   channel
}	__attribute__ ((packed))
AdcToken	enableFastAdcChannel (const char *msg, adc_channel_e channel)
adcsample_t	getFastAdc (AdcToken token)
const ADCConversionGroup *	getKnockConversionGroup (uint8_t channelIdx)
void	onKnockSamplingComplete ()
float	getMCUInternalTemperature (void)
float	getMCUVref (void)
void	waitForSlowAdc (uint32_t lastAdcCounter=1)
void	printFullAdcReport (void)

Variables
static constexpr AdcToken	invalidAdcToken = (AdcToken)(-1)

Typedef Documentation

AdcTockenInternal

using AdcTockenInternal = union { AdcToken token

Definition at line 100 of file adc_inputs.h.

AdcToken

using AdcToken = uint32_t

Definition at line 98 of file adc_inputs.h.

Enumeration Type Documentation

AdcChannelMode

enum class AdcChannelMode : char

strong

Enumerator
Off
Slow
Fast

Definition at line 77 of file adc_inputs.h.

                          : char {
    Off,
    Slow,
    Fast
};

Function Documentation

__attribute__()

struct @29 __attribute__

(

(packed)

)

Definition at line 38 of file tooth_logger.h.

                                        {
    // the whole order of all packet bytes is reversed, not just the 'endian-swap' integers
    uint32_t timestamp;
    // unfortunately all these fields are required by TS...
    bool priLevel : 1;
    bool secLevel : 1;
    bool trigger : 1;
    bool sync : 1;
    bool coil : 1;
    bool injector : 1;
} composite_logger_s;

adcInputsUpdateSubscribers()

void adcInputsUpdateSubscribers

(

efitick_t

nowNt

)

Definition at line 181 of file adc_inputs.cpp.

                                                 {
    adcOnchipSlowUpdate(nowNt);
 
    {
        ScopePerf perf(PE::AdcProcessSlow);
 
        AdcSubscription::UpdateSubscribers(nowNt);
 
        protectedGpio_check(nowNt);
    }
}

Referenced by initAdcInputs(), and MainLoop::PeriodicTask().

Here is the call graph for this function:

Here is the caller graph for this function:

addFastAdcChannel()

void addFastAdcChannel	(	const char *	name,
		adc_channel_e	hwChannel
	)

Definition at line 193 of file adc_inputs.cpp.

                                                             {
    if (!isAdcChannelValid(hwChannel)) {
        return;
    }
 
#if EFI_USE_FAST_ADC
    fastAdc.enableChannel(hwChannel);
#endif
 
    adcHwChannelMode[hwChannel] = AdcChannelMode::Fast;
    // Nothing to do for slow channels, input is mapped to analog in init_sensors.cpp
}

Referenced by addAdcChannelForTrigger(), configureInputs(), and setAdcChannelOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

analogGetDiagnostic()

ObdCode analogGetDiagnostic

(

)

Definition at line 59 of file adc_inputs.cpp.

{
    /* TODO: debounce? */
    auto code = analogGetVrefDiagnostic();
    if (code != ObdCode::None) {
        return code;
    }
 
    return boardGetAnalogDiagnostic();
}

Referenced by SensorChecker::onSlowCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

boardAdjustVoltage()

float boardAdjustVoltage	(	float	voltage,
		adc_channel_e	hwChannel
	)

Definition at line 15 of file adc_inputs.cpp.

                                                                         {
    // a hack useful when we do not trust voltage just after board EN was turned on. is this just hiding electrical design flaws?
    return voltage;
}

Referenced by adcGetScaledVoltage().

Here is the caller graph for this function:

boardGetAnalogInputDiagnostic()

int boardGetAnalogInputDiagnostic	(	adc_channel_e	hwChannel,
		float	voltage
	)

Definition at line 262 of file board_configuration.cpp.

                                                                          {
    /* we do not check voltage for valid ragne yet */
    (void)voltage;
 
    switch (hwChannel) {
        /* inputs that may be affected by incorrect reference voltage */
        case MM176_IN_TPS_ANALOG:
        case MM176_IN_TPS2_ANALOG:
        case MM176_IN_PPS1_ANALOG:
        case MM176_IN_PPS2_ANALOG:
        case MM176_IN_IAT_ANALOG:
        case MM176_IN_AT1_ANALOG:
        case MM176_IN_CLT_ANALOG:
        case MM176_IN_AT2_ANALOG:
        //case MM176_IN_O2S_ANALOG:
        //case MM176_IN_O2S2_ANALOG:
        case MM176_IN_MAP1_ANALOG:
        case MM176_IN_MAP2_ANALOG:
        case MM176_IN_AUX1_ANALOG:
        case MM176_IN_AUX2_ANALOG:
        case MM176_IN_AUX3_ANALOG:
        case MM176_IN_AUX4_ANALOG:
            /* TODO: more? */
            return (boardGetAnalogDiagnostic() == ObdCode::None) ? 0 : -1;
        /* all other inputs should not rely on output 5V */
        default:
            return 0;
    }
 
    return 0;
}

Referenced by adcGetRawVoltage().

Here is the call graph for this function:

Here is the caller graph for this function:

enableFastAdcChannel()

AdcToken enableFastAdcChannel	(	const char *	msg,
		adc_channel_e	channel
	)

Definition at line 279 of file mpu_util.cpp.

                                                                  {
    if (!isAdcChannelValid(channel)) {
        return invalidAdcToken;
    }
 
    // TODO: implement me!
    return invalidAdcToken;
}

Referenced by calcFastAdcIndexes().

Here is the call graph for this function:

Here is the caller graph for this function:

getAdcMode()

AdcChannelMode getAdcMode

(

adc_channel_e

hwChannel

)

Definition at line 110 of file adc_inputs.cpp.

                                                   {
    return adcHwChannelMode[hwChannel];
}

Referenced by AdcSubscription::PrintInfo().

Here is the caller graph for this function:

getAnalogInputDividerCoefficient()

float getAnalogInputDividerCoefficient

(

adc_channel_e

hwChannel

)

Definition at line 242 of file hellen_common.cpp.

                                                                {
#if (HELLEN_BOARD_MM64 == TRUE)
    (void)hwChannel;
    if (0)
#endif
#if (HELLEN_BOARD_MM100 == TRUE)
    if (hwChannel == MM100_IN_CRANK_ANALOG) [[unlikely]]
#endif
#if (HELLEN_BOARD_MM144 == TRUE)
    if (hwChannel == H144_IN_CRANK_ANALOG) [[unlikely]]
#endif
#if (HELLEN_BOARD_MM176 == TRUE)
    if (hwChannel == MM176_IN_CRANK_ANALOG) [[unlikely]]
#endif
    {
        // (4.7K || 5.1K) + 4.7K divider
        // 4.7K || 5.1K == 2.445K
        return (4.7f + 2.445f) / 4.7f;
    }
 
    return engineConfiguration->analogInputDividerCoefficient;
}

Referenced by adcGetScaledVoltage().

Here is the caller graph for this function:

getFastAdc()

adcsample_t getFastAdc

(

AdcToken

token

)

Definition at line 288 of file mpu_util.cpp.

                                       {
    if (token == invalidAdcToken) {
        return 0;
    }
 
    // TODO: implement me!
    return 0;
}

Referenced by onFastAdcComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

getInternalAdcValue()

int getInternalAdcValue	(	const char *	msg,
		adc_channel_e	index
	)

Definition at line 116 of file adc_inputs.cpp.

                                                                  {
    if (!isAdcChannelValid(hwChannel)) {
        warning(ObdCode::CUSTOM_OBD_ANALOG_INPUT_NOT_CONFIGURED, "ADC: %s input is not configured", msg);
        return -1;
    }
 
#if EFI_USE_FAST_ADC
    if (adcHwChannelMode[hwChannel] == AdcChannelMode::Fast) {
        return fastAdc.getAvgAdcValue(hwChannel);
    }
#endif // EFI_USE_FAST_ADC
 
    return adcOnchipSlowGetAvgRaw(hwChannel);
}

Here is the call graph for this function:

getKnockConversionGroup()

const ADCConversionGroup * getKnockConversionGroup

(

uint8_t

channelIdx

)

Definition at line 409 of file stm32_adc_v2.cpp.

                                                                      {
#if KNOCK_HAS_CH2
    if (channelIdx == 1) {
        return &adcConvGroupCh2;
    }
#else
    (void)channelIdx;
#endif // KNOCK_HAS_CH2
 
    return &adcConvGroupCh1;
}

Referenced by onStartKnockSampling().

Here is the caller graph for this function:

getMCUInternalTemperature()

float getMCUInternalTemperature

(

void

)

Definition at line 78 of file adc_onchip_slow.cpp.

                                  {
    return mcuTemperature;
}

Referenced by populateFrame(), and updateMiscSensors().

Here is the caller graph for this function:

getMCUVref()

float getMCUVref

(

void

)

Definition at line 82 of file adc_onchip_slow.cpp.

                   {
    return mcuVrefVoltage;
}

Referenced by analogGetVrefDiagnostic(), and updateMiscSensors().

Here is the caller graph for this function:

initAdcInputs()

void initAdcInputs

(

)

Definition at line 241 of file adc_inputs.cpp.

                     {
    efiPrintf("initAdcInputs()");
 
    configureInputs();
 
    // migrate to 'enable adcdebug'
    addConsoleActionI("adcdebug", &setAdcDebugReporting);
 
#if EFI_INTERNAL_ADC
    // This will start HW for all used ADCs
    portInitAdc();
 
#if EFI_USE_FAST_ADC
    // After this point fastAdc is not allowed to add channels
    fastAdc.init();
#endif // EFI_USE_FAST_ADC
 
    addConsoleActionI("adc", (VoidInt) printAdcValue);
#else // ! EFI_INTERNAL_ADC
    efiPrintf("ADC disabled");
#endif // EFI_INTERNAL_ADC
 
    // Workaround to pre-feed all sensors with some data...
    chThdSleepMilliseconds(1);
    adcInputsUpdateSubscribers(getTimeNowNt());
}

Referenced by initHardware().

Here is the call graph for this function:

Here is the caller graph for this function:

isAdcChannelOffChip()

bool isAdcChannelOffChip ( adc_channel_e  hwChannel )

inline

Definition at line 40 of file adc_inputs.h.

                                                         {
    return (isAdcChannelValid(hwChannel) && (hwChannel > EFI_ADC_ONCHIP_LAST));
}

Here is the call graph for this function:

isAdcChannelOnChip()

bool isAdcChannelOnChip ( adc_channel_e  hwChannel )

inline

Definition at line 36 of file adc_inputs.h.

                                                        {
    return (isAdcChannelValid(hwChannel) && (hwChannel <= EFI_ADC_ONCHIP_LAST));
}

Referenced by boardGetAnalogInputDiagnostic().

Here is the call graph for this function:

Here is the caller graph for this function:

isAdcChannelValid()

bool isAdcChannelValid ( adc_channel_e  hwChannel )

inline

Definition at line 23 of file adc_inputs.h.

                                                       {
    /* Compiler will optimize, keep following if as a reminder */
    if (hwChannel >= EFI_ADC_TOTAL_CHANNELS) {
        /* this should not happen!
         * if we have enum out of range somewhere in settings
         * that means something goes terribly wrong
         * TODO: should we say something?
         */
        return false;
    }
    return ((hwChannel > EFI_ADC_NONE) && (hwChannel < EFI_ADC_TOTAL_CHANNELS));
}

Referenced by adcPrintChannelReport(), addAdcChannelForTrigger(), addFastAdcChannel(), configTherm(), configureTempSensor(), deInitIfValid(), enableFastAdcChannel(), enableFastAdcChannel(), enableFastAdcChannel(), getAfr(), getInternalAdcValue(), getPinNameByAdcChannel(), hasAfrSensor(), initAuxSensors(), initFlexSensor(), initFluidPressure(), initFuelLevel(), initIfValid(), initLambda(), initMaf(), initMap(), initOldAnalogInputs(), initRangeSensors(), initTps(), initVbatt(), isAdcChannelOffChip(), isAdcChannelOnChip(), removeChannel(), slowAdcEnableDisableChannel(), GenericGearController::update(), and updateRawSensors().

Here is the caller graph for this function:

onKnockSamplingComplete()

void onKnockSamplingComplete

(

)

Definition at line 41 of file software_knock.cpp.

                               {
    knockNeedsProcess = true;
 
    // Notify the processing thread that it's time to process this sample
    chSysLockFromISR();
    knockSem.signalI();
    chSysUnlockFromISR();
}

Referenced by knockCompletionCallback(), and knockCompletionCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

printFullAdcReport()

void printFullAdcReport

(

void

)

Definition at line 160 of file adc_inputs.cpp.

                              {
#if EFI_USE_FAST_ADC
    efiPrintf("fast %u samples", engine->outputChannels.fastAdcConversionCount);
 
    for (int internalIndex = 0; internalIndex < fastAdc.size(); internalIndex++) {
        adc_channel_e hwChannel = fastAdc.getAdcChannelByInternalIndex(internalIndex);
 
        adcPrintChannelReport("F", internalIndex, hwChannel);
    }
#endif // EFI_USE_FAST_ADC
 
    adcOnchipSlowShowReport();
}

Referenced by initSettings(), and printFullAdcReportIfNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

printFullAdcReportIfNeeded()

void printFullAdcReportIfNeeded

(

void

)

Definition at line 268 of file adc_inputs.cpp.

                                      {
    if (!adcDebugReporting)
        return;
    printFullAdcReport();
}

Referenced by updateDevConsoleState().

Here is the call graph for this function:

Here is the caller graph for this function:

removeChannel()

void removeChannel	(	const char *	name,
		adc_channel_e	hwChannel
	)

Definition at line 206 of file adc_inputs.cpp.

                                                         {
    if (!isAdcChannelValid(hwChannel)) {
        return;
    }
#if EFI_USE_FAST_ADC
    if (adcHwChannelMode[hwChannel] == AdcChannelMode::Fast) {
        /* TODO: */
        //fastAdc.disableChannel(hwChannel);
    }
#endif
 
    adcHwChannelMode[hwChannel] = AdcChannelMode::Off;
}

Referenced by setAdcChannelOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

waitForSlowAdc()

void waitForSlowAdc

(

uint32_t

lastAdcCounter = 1

)

Definition at line 87 of file adc_onchip_slow.cpp.

                                             {
    // note that having ADC reading is one thing while having new sensor API is a totally different thing!
    // todo: use sync.objects?
    while (slowAdcConversionCount <= lastAdcCounter) {
        chThdSleepMilliseconds(1);
    }
}

Referenced by StepperMotorBase::setInitialPosition().

Here is the caller graph for this function:

Variable Documentation

adc

beuint16_t adc

Definition at line 103 of file adc_inputs.h.

Referenced by getAdcInternalChannel(), and getHwChannelForAdcInput().

channel

uint16_t channel

Definition at line 104 of file adc_inputs.h.

Referenced by addAdcChannelForTrigger(), boardGetAnalogInputDiagnostic(), CH_IRQ_HANDLER(), comp_lld_channel_enable(), configureRusefiLuaHooks(), configureTempSensor(), createRequest(), deInitIfValid(), disableTriggerStimulator(), DMAMUX_DisableChannel(), DMAMUX_DisablePeriodTrigger(), DMAMUX_EnableAlwaysOn(), DMAMUX_EnableChannel(), DMAMUX_EnablePeriodTrigger(), DMAMUX_SetSource(), EDMA_ClearChannelStatusFlags(), EDMA_CreateHandle(), EDMA_DisableChannelInterrupts(), EDMA_DisableChannelRequest(), EDMA_EnableAsyncRequest(), EDMA_EnableAutoStopRequest(), EDMA_EnableChannelInterrupts(), EDMA_EnableChannelRequest(), EDMA_GetChannelStatusFlags(), EDMA_GetRemainingMajorLoopCount(), EDMA_InstallTCD(), EDMA_ResetChannel(), EDMA_SetBandWidth(), EDMA_SetChannelLink(), EDMA_SetChannelPreemptionConfig(), EDMA_SetMinorOffsetConfig(), EDMA_SetModulo(), EDMA_SetTransferConfig(), EDMA_TriggerChannelStart(), efiExtiDisablePin(), efiExtiEnablePin(), emulatorApplyPinState(), enableFastAdcChannel(), enableFastAdcChannel(), Dac::GetLastVoltage(), getMcp3208adc(), getSentValue(), getSentValues(), getValue(), gpt_lld_polled_delay(), TriggerEmulatorHelper::handleEmulatorCallback(), initAuxSensors(), initFluidPressure(), initFuelLevel(), initIfValid(), initMaf(), initRangeSensors(), luaL_checkPwmIndex(), printAdcValue(), AdcSubscription::PrintInfo(), printSentInfo(), pwm_lld_disable_channel(), pwm_lld_disable_channel_notification(), pwm_lld_enable_channel(), pwm_lld_enable_channel_notification(), Ads1015::readChannel(), readGppwmChannel(), requestAdcValue(), requestAdcValueI(), sendToPot(), SENT_ISR_Handler(), SentDecoderThread(), setAnalogInputPin(), setDacVoltage(), setPotResistance(), setTriggerEmulatorRPM(), Dac::SetVoltage(), startKnockSampling(), startSimulatedTriggerSignal(), startTriggerEmulatorPins(), startTriggerInputPins(), stopTriggerEmulatorPins(), TunerstudioThread::ThreadTask(), updateRawSensors(), updateTriggerWaveformIfNeeded(), and validateCanChannelAndConvertFromHumanIntoZeroIndex().

invalidAdcToken

constexpr AdcToken invalidAdcToken = (AdcToken)(-1)

staticconstexpr

Definition at line 110 of file adc_inputs.h.

Referenced by enableFastAdcChannel(), enableFastAdcChannel(), enableFastAdcChannel(), and getFastAdc().

Go to the source code of this file.