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)
bool	isAdcChannelValid (adc_channel_e hwChannel)
bool	isAdcChannelOnChip (adc_channel_e hwChannel)
bool	isAdcChannelOffChip (adc_channel_e hwChannel)
int	analogGetDiagnostic ()
void	updateSlowAdc (efitick_t nowNt)
AdcChannelMode	getAdcMode (adc_channel_e hwChannel)
void	initAdcInputs ()
void	waitForSlowAdc (uint32_t lastAdcCounter=1)
void	printFullAdcReportIfNeeded (void)
int	getInternalAdcValue (const char *msg, adc_channel_e index)
float	getMCUInternalTemperature (void)
void	addFastAdcChannel (const char *name, adc_channel_e hwChannel)
void	removeChannel (const char *name, adc_channel_e hwChannel)
void	onFastAdcComplete (adcsample_t *samples)
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 ()
void	printFullAdcReport (void)

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

Typedef Documentation

AdcTockenInternal

using AdcTockenInternal = union { AdcToken token

Definition at line 105 of file adc_inputs.h.

AdcToken

using AdcToken = uint32_t

Definition at line 103 of file adc_inputs.h.

Enumeration Type Documentation

AdcChannelMode

enum class AdcChannelMode : char

strong

Enumerator
Off
Slow
Fast

Definition at line 75 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;

addFastAdcChannel()

void addFastAdcChannel	(	const char *	name,
		adc_channel_e	hwChannel
	)

Definition at line 175 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()

int analogGetDiagnostic

(

)

Definition at line 41 of file adc_inputs.cpp.

{
    /* TODO: debounce? */
    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:

enableFastAdcChannel()

AdcToken enableFastAdcChannel	(	const char *	msg,
		adc_channel_e	channel
	)

Definition at line 274 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 69 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 111 of file board_configuration.cpp.

                                                                {
    switch (hwChannel) {
        /* MAP, TPS, MAF (na), AC press (na) */
        case EFI_ADC_0:
        case EFI_ADC_1:
        case EFI_ADC_11:
        case EFI_ADC_6:
            return (22.0 + 41.2) / 41.2;
 
        /* IAT, CLT */
        case EFI_ADC_3:
        case EFI_ADC_14:
            /* no divider, 1.5K pull-up to 3.3V, 22K pull-down */
            /* TODO: handle both pull-up and pull-down */
            return 1.0;
 
        /* AFR 1, AFR 2 (na), knock (TBD) */
        case EFI_ADC_7:
        case EFI_ADC_5:
        case EFI_ADC_2:
            /* no divider */
            return 1.0;
 
        /* +12 sense, Ignition switch */
        case EFI_ADC_9:
        case EFI_ADC_8:
            return (68.0 + 6.8) / 6.8;
 
        /* 5V feedback */
        case EFI_ADC_10:
            return (10.0 + 10.0) / 10.0;
 
        /* Ignition feedback */
        case EFI_ADC_12:
        case EFI_ADC_13:
            /* TBD */
            return 1.0;
 
        default:
            return engineConfiguration->analogInputDividerCoefficient;
    }
    return engineConfiguration->analogInputDividerCoefficient;
}

Referenced by adcGetScaledVoltage().

Here is the caller graph for this function:

getFastAdc()

adcsample_t getFastAdc

(

AdcToken

token

)

Definition at line 283 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 77 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 slowAdcSamples[hwChannel - EFI_ADC_0];
}

Here is the call graph for this function:

getKnockConversionGroup()

const ADCConversionGroup * getKnockConversionGroup

(

uint8_t

channelIdx

)

Definition at line 369 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 73 of file adc_inputs.cpp.

                                  {
    return mcuTemperature;
}

Referenced by populateFrame(), and updateMiscSensors().

Here is the caller graph for this function:

initAdcInputs()

void initAdcInputs

(

)

Definition at line 231 of file adc_inputs.cpp.

                     {
    efiPrintf("initAdcInputs()");
 
    configureInputs();
 
    // migrate to 'enable adcdebug'
    addConsoleActionI("adcdebug", &setAdcDebugReporting);
 
#if EFI_INTERNAL_ADC
    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);
    updateSlowAdc(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 38 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 34 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 21 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 addAdcChannelForTrigger(), addFastAdcChannel(), configTherm(), configureTempSensor(), deInitIfValid(), enableFastAdcChannel(), enableFastAdcChannel(), getAfr(), getInternalAdcValue(), getPinNameByAdcChannel(), hasAfrSensor(), initAuxSensors(), initFlexSensor(), initFluidPressure(), initFuelLevel(), initIfValid(), initLambda(), initMaf(), initMap(), initOldAnalogInputs(), initRangeSensors(), initTps(), initVbatt(), isAdcChannelOffChip(), isAdcChannelOnChip(), printAdcChannedReport(), removeChannel(), GenericGearController::update(), and updateRawSensors().

Here is the caller graph for this function:

onFastAdcComplete()

void onFastAdcComplete

(

adcsample_t *

samples

)

This method is not in the adc* lower-level file because it is more business logic then hardware.

this callback is executed 10 000 times a second, it needs to be as fast as possible

Definition at line 269 of file hardware.cpp.

                                     {
    ScopePerf perf(PE::AdcCallbackFast);
 
#if HAL_TRIGGER_USE_ADC
    // we need to call this ASAP, because trigger processing is time-critical
    triggerAdcCallback(getFastAdc(triggerSampleIndex));
#endif /* HAL_TRIGGER_USE_ADC */
 
    /**
     * this callback is executed 10 000 times a second, it needs to be as fast as possible
     */
    efiAssertVoid(ObdCode::CUSTOM_STACK_ADC, hasLotsOfRemainingStack(), "lowstck#9b");
 
#if EFI_MAP_AVERAGING && defined (MODULE_MAP_AVERAGING)
    mapAveragingAdcCallback(adcRawValueToScaledVoltage(getFastAdc(fastMapSampleIndex), engineConfiguration->map.sensor.hwChannel));
#endif /* EFI_MAP_AVERAGING */
}

Referenced by adc_callback(), and fastAdcDoneCB().

Here is the call graph for this function:

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 119 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);
 
        printAdcChannedReport("F", internalIndex, hwChannel);
    }
#endif // EFI_USE_FAST_ADC
    efiPrintf("slow %lu samples", slowAdcConversionCount);
 
    /* we assume that all slow ADC channels are enabled */
    for (int internalIndex = 0; internalIndex < ADC_MAX_CHANNELS_COUNT; internalIndex++) {
        adc_channel_e hwChannel = static_cast<adc_channel_e>(internalIndex + EFI_ADC_0);
 
        printAdcChannedReport("S", internalIndex, hwChannel);
    }
}

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 257 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 188 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:

updateSlowAdc()

void updateSlowAdc

(

efitick_t

nowNt

)

Definition at line 144 of file adc_inputs.cpp.

                                    {
    {
        ScopePerf perf(PE::AdcConversionSlow);
 
        /* drop volatile type qualifier - this is safe */
        if (!readSlowAnalogInputs((adcsample_t *)slowAdcSamples)) {
            engine->outputChannels.slowAdcErrorCount++;
            return;
        }
 
        // Ask the port to sample the MCU temperature
        mcuTemperature = getMcuTemperature();
        if (mcuTemperature > 150.0f || mcuTemperature < -50.0f) {
            /*
             * we have a sporadic issue with this check todo https://github.com/rusefi/rusefi/issues/2552
             */
            //criticalError("Invalid CPU temperature measured %f", degrees);
        }
    }
 
    {
        ScopePerf perf(PE::AdcProcessSlow);
 
        slowAdcConversionCount++;
 
        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:

waitForSlowAdc()

void waitForSlowAdc

(

uint32_t

lastAdcCounter = 1

)

Definition at line 223 of file adc_inputs.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 108 of file adc_inputs.h.

Referenced by getAdcInternalChannel().

channel

uint16_t channel

Definition at line 109 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 115 of file adc_inputs.h.

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

Go to the source code of this file.