Detailed Description

This file is about producing real electrical signals which emulate trigger signal based on a known TriggerWaveform.

Historically this implementation was implemented based on PwmConfig which is maybe not the best way to implement it. (todo: why is not the best way?)

A newer implementation of pretty much the same thing is TriggerStimulatorHelper todo: one emulator should be enough! another one should be eliminated

Date: Mar 3, 2014

Author: Andrey Belomutskiy, (c) 2012-2020

Definition in file trigger_emulator_algo.cpp.

Functions
int	getPreviousIndex (const int currentIndex, const int size)

bool	needEvent (const int currentIndex, const MultiChannelStateSequence &mcss, int channelIndex)

	fail ("EFI_SHAFT_POSITION_INPUT required to have EFI_EMULATE_POSITION_SENSORS") TriggerEmulatorHelper

static float	getRpmMultiplier (operation_mode_e mode)

void	setTriggerEmulatorRPM (int rpm)

static void	updateTriggerWaveformIfNeeded (PwmConfig *state)

static void	emulatorApplyPinState (int stateIndex, PwmConfig *state)

static void	startSimulatedTriggerSignal ()

void	enableTriggerStimulator (bool incGlobalConfiguration)

void	enableExternalTriggerStimulator ()

void	disableTriggerStimulator ()

void	onConfigurationChangeRpmEmulatorCallback (engine_configuration_s *previousConfiguration)

void	initTriggerEmulator ()

void	startTriggerEmulatorPins ()

void	stopTriggerEmulatorPins ()

Variables
static OutputPin	emulatorOutputs [NUM_EMULATOR_CHANNELS][PWM_PHASE_MAX_WAVE_PER_PWM]

PwmConfig	triggerEmulatorSignals [NUM_EMULATOR_CHANNELS]

TriggerWaveform *	triggerEmulatorWaveforms [NUM_EMULATOR_CHANNELS]

static int	atTriggerVersions [NUM_EMULATOR_CHANNELS] = { 0 }

static TriggerEmulatorHelper	helper

static bool	hasStimPins = false

static bool	hasInitTriggerEmulator = false

Function Documentation

◆ disableTriggerStimulator()

void disableTriggerStimulator ( )

Definition at line 211 of file trigger_emulator_algo.cpp.

                                 {
     engine->triggerCentral.directSelfStimulation = false;
     for (int channel = 0; channel < NUM_EMULATOR_CHANNELS; channel++) {
         triggerEmulatorSignals[channel].stop();
     }
     hasInitTriggerEmulator = false;
     incrementGlobalConfigurationVersion("disTrg");
 }

Referenced by configureRusefiLuaHooks(), enableOrDisable(), handleCommandX14(), and hwHandleShaftSignal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ emulatorApplyPinState()

static void emulatorApplyPinState	(	int	stateIndex,
		PwmConfig *	state
	)

static

this callback would invoke the input signal handlers directly

Definition at line 143 of file trigger_emulator_algo.cpp.

                                                                       {
     assertStackVoid("emulator", ObdCode::STACK_USAGE_MISC, EXPECTED_REMAINING_STACK);
     if (engine->triggerCentral.directSelfStimulation) {
         /**
          * this callback would invoke the input signal handlers directly
          */
         for (int channel = 0; channel < NUM_EMULATOR_CHANNELS; channel++) {
             if (state != &triggerEmulatorSignals[channel])
                 continue;
             helper.handleEmulatorCallback(channel,
                 *state->multiChannelStateSequence,
                 stateIndex);
         }
     }
  
 #if EFI_PROD_CODE
     // Only set pins if they're configured - no need to waste the cycles otherwise
     else if (hasStimPins) {
         applyPinState(stateIndex, state);
     }
 #endif /* EFI_PROD_CODE */
 }

Referenced by startSimulatedTriggerSignal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableExternalTriggerStimulator()

void enableExternalTriggerStimulator ( )

Definition at line 205 of file trigger_emulator_algo.cpp.

                                        {
     startSimulatedTriggerSignal();
     engine->triggerCentral.directSelfStimulation = false;
     incrementGlobalConfigurationVersion("extTrg");
 }

Referenced by enableOrDisable(), and handleCommandX14().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableTriggerStimulator()

void enableTriggerStimulator ( bool incGlobalConfiguration )

Definition at line 194 of file trigger_emulator_algo.cpp.

                                                           {
     startSimulatedTriggerSignal();
     engine->triggerCentral.directSelfStimulation = true;
     engine->rpmCalculator.Register();
     if (incGlobalConfiguration) {
         incrementGlobalConfigurationVersion("trgSim");
     }
 }

Referenced by commonEarlyInit(), configureRusefiLuaHooks(), enableOrDisable(), and handleCommandX14().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fail()

fail ( "EFI_SHAFT_POSITION_INPUT required to have EFI_EMULATE_POSITION_SENSORS" )

this instance does not have a real physical pin - it's only used for engine sniffer

todo: we can kind of add real physical pin just for a very narrow case of troubleshooting but only if we ever need it :)

Engine idles around 20Hz and revs up to 140Hz, at 60/2 and 8 cylinders we have about 20Khz events If we can read buffer at 50Hz we want buffer to be about 400 elements.

Definition at line 34 of file trigger_emulator_algo.cpp.

41 {

42 }

◆ getPreviousIndex()

int getPreviousIndex	(	const int	currentIndex,
		const int	size
	)

Definition at line 19 of file trigger_emulator_algo.cpp.

                                                              {
     return (currentIndex + size - 1) % size;
 }

Referenced by TriggerStimulatorHelper::feedSimulatedEvent(), and needEvent().

Here is the caller graph for this function:

◆ getRpmMultiplier()

static float getRpmMultiplier ( operation_mode_e mode )

static

todo: why is this method NOT reciprocal to getCrankDivider?! todo: oh this method has only one usage? there must me another very similar method!

Definition at line 78 of file trigger_emulator_algo.cpp.

                                                      {
   switch (mode) {
     case FOUR_STROKE_SYMMETRICAL_CRANK_SENSOR:
     case FOUR_STROKE_THREE_TIMES_CRANK_SENSOR:
     case FOUR_STROKE_SIX_TIMES_CRANK_SENSOR:
       case FOUR_STROKE_TWELVE_TIMES_CRANK_SENSOR:
       case FOUR_STROKE_CRANK_SENSOR:
       case FOUR_STROKE_CAM_SENSOR:
       case OM_NONE:
         return getCrankDivider(mode) / 2.0;
       case TWO_STROKE:
           // unit test coverage still runs if the value below is changed to '2' not a great sign!
           // but HW CI insists that we have '1' here
           return 1;
     };
     criticalError("We should not have reach this line");
     return 1;
 }

Referenced by setTriggerEmulatorRPM().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initTriggerEmulator()

void initTriggerEmulator ( )

Definition at line 228 of file trigger_emulator_algo.cpp.

                            {
     efiPrintf("Emulating %s", getEngine_type_e(engineConfiguration->engineType));
  
     startTriggerEmulatorPins();
  
     addConsoleActionI(CMD_RPM, setTriggerEmulatorRPM);
 }

Referenced by initEngineEmulator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ needEvent()

bool needEvent	(	const int	currentIndex,
		const MultiChannelStateSequence &	mcss,
		int	channelIndex
	)

Definition at line 23 of file trigger_emulator_algo.cpp.

                                                                                                  {
     int prevIndex = getPreviousIndex(currentIndex, mcss.phaseCount);
     pin_state_t previousValue = mcss.getChannelState(channelIndex, /*phaseIndex*/prevIndex);
     pin_state_t currentValue = mcss.getChannelState(channelIndex, /*phaseIndex*/currentIndex);
  
     return previousValue != currentValue;
 }

Referenced by TriggerStimulatorHelper::feedSimulatedEvent(), and TriggerEmulatorHelper::handleEmulatorCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onConfigurationChangeRpmEmulatorCallback()

void onConfigurationChangeRpmEmulatorCallback ( engine_configuration_s * previousConfiguration )

Definition at line 220 of file trigger_emulator_algo.cpp.

                                                                                              {
     if (engineConfiguration->triggerSimulatorRpm ==
             previousConfiguration->triggerSimulatorRpm) {
         return;
     }
     setTriggerEmulatorRPM(engineConfiguration->triggerSimulatorRpm);
 }

Referenced by incrementGlobalConfigurationVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTriggerEmulatorRPM()

void setTriggerEmulatorRPM ( int rpm )

All we need to do here is to change the periodMs togglePwmState() would see that the periodMs has changed and act accordingly

Definition at line 97 of file trigger_emulator_algo.cpp.

                                     {
   criticalAssertVoid(rpm >= 0 && rpm <= 30000, "emulator RPM out of range");
  
     engineConfiguration->triggerSimulatorRpm = rpm;
     /**
      * All we need to do here is to change the periodMs
      * togglePwmState() would see that the periodMs has changed and act accordingly
      */
     for (int channel = 0; channel < NUM_EMULATOR_CHANNELS; channel++) {
         float rPerSecond = NAN;
         if (rpm != 0) {
             // use 0.5 multiplier for cam
             float rpmM = (channel == 0) ? getRpmMultiplier(getEngineRotationState()->getOperationMode()) : 0.5f;
             rPerSecond = rpm * rpmM / 60.0; // per minute converted to per second
         }
         triggerEmulatorSignals[channel].setFrequency(rPerSecond);
     }
  
     engine->resetEngineSnifferIfInTestMode();
  
     efiPrintf("Emulating position sensor(s). RPM=%d", rpm);
 }

Referenced by configureRusefiLuaHooks(), initTriggerEmulator(), onConfigurationChangeRpmEmulatorCallback(), Engine::periodicSlowCallback(), setValue(), and startSimulatedTriggerSignal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startSimulatedTriggerSignal()

static void startSimulatedTriggerSignal ( )

static

Definition at line 166 of file trigger_emulator_algo.cpp.

                                           {
     // No need to start more than once
     if (hasInitTriggerEmulator) {
         return;
     }
  
     // store the crank+cam waveforms
     triggerEmulatorWaveforms[0] = &engine->triggerCentral.triggerShape;
     for (int cami = 0; cami < CAMS_PER_BANK; cami++) {
         triggerEmulatorWaveforms[1 + cami] = &engine->triggerCentral.vvtShape[cami];
     }
  
     setTriggerEmulatorRPM(engineConfiguration->triggerSimulatorRpm);
  
     for (int channel = 0; channel < NUM_EMULATOR_CHANNELS; channel++) {
         TriggerWaveform *s = triggerEmulatorWaveforms[channel];
         if (s->getSize() == 0)
             continue;
         triggerEmulatorSignals[channel].weComplexInit(
             &engine->executor,
             &s->wave,
             updateTriggerWaveformIfNeeded, emulatorApplyPinState);
     }
     hasInitTriggerEmulator = true;
 }

Referenced by enableExternalTriggerStimulator(), and enableTriggerStimulator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startTriggerEmulatorPins()

void startTriggerEmulatorPins ( )

Definition at line 238 of file trigger_emulator_algo.cpp.

                                 {
     hasStimPins = false;
     for (int channel = 0; channel < NUM_EMULATOR_CHANNELS; channel++) {
         for (size_t i = 0; i < efi::size(emulatorOutputs[channel]); i++) {
             triggerEmulatorSignals[channel].outputPins[i] = &emulatorOutputs[channel][i];
  
 #if EFI_PROD_CODE
       brain_pin_e pin;
  
       pin_output_mode_e outputMode;
             if (channel == 0) {
             pin = engineConfiguration->triggerSimulatorPins[i];
             outputMode = engineConfiguration->triggerSimulatorPinModes[i];
         } else if (channel == 1 && i == 0) {
           pin = engineConfiguration->camSimulatorPin;
           outputMode = engineConfiguration->camSimulatorPinMode;
         } else {
               // todo: add pin configs for cam simulator channels
           continue;
         }
  
             // Only bother trying to set output pins if they're configured
             if (isBrainPinValid(pin)) {
                 hasStimPins = true;
             }
  
             if (isConfigurationChanged(triggerSimulatorPins[i])) {
                 triggerEmulatorSignals[channel].outputPins[i]->initPin("Trigger emulator", pin,
                     outputMode);
             }
 #endif // EFI_PROD_CODE
         }
     }
 }

Referenced by applyNewHardwareSettings(), and initTriggerEmulator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stopTriggerEmulatorPins()

void stopTriggerEmulatorPins ( )

Definition at line 273 of file trigger_emulator_algo.cpp.

                                {
 #if EFI_PROD_CODE
     for (int channel = 0; channel < NUM_EMULATOR_CHANNELS; channel++) {
         // todo: add pin configs for cam simulator channels
         if (channel != 0)
             continue;
         for (size_t i = 0; i < efi::size(emulatorOutputs[channel]); i++) {
             if (isConfigurationChanged(triggerSimulatorPins[i])) {
                 triggerEmulatorSignals[channel].outputPins[i]->deInit();
             }
         }
     }
 #endif // EFI_PROD_CODE
 }

Referenced by stopHardware().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateTriggerWaveformIfNeeded()

static void updateTriggerWaveformIfNeeded ( PwmConfig * state )

static

Definition at line 120 of file trigger_emulator_algo.cpp.

                                                             {
     for (int channel = 0; channel < NUM_EMULATOR_CHANNELS; channel++) {
         if (state != &triggerEmulatorSignals[channel])
             continue;
  
     if (atTriggerVersions[channel] < triggerEmulatorWaveforms[channel]->version) {
             atTriggerVersions[channel] = triggerEmulatorWaveforms[channel]->version;
             efiPrintf("Stimulator: updating trigger shape for ch%d: %d/%d %ld", channel, atTriggerVersions[channel],
                 engine->getGlobalConfigurationVersion(), getTimeNowMs());
  
             copyPwmParameters(state, &triggerEmulatorWaveforms[channel]->wave);
             state->safe.periodNt = -1; // this would cause loop re-initialization
         }
     }
 }