rusefi/firmware/controllers/algo/engine.h

369 lines
8.8 KiB
C++

/**
* @file engine.h
*
* @date May 21, 2014
* @author Andrey Belomutskiy, (c) 2012-2020
*/
#pragma once
#include "global_shared.h"
#include "engine_module.h"
#include "engine_state.h"
#include "rpm_calculator.h"
#include "event_registry.h"
#include "table_helper.h"
#include "listener_array.h"
#include "accel_enrichment.h"
#include "trigger_central.h"
#include "local_version_holder.h"
#include "buttonshift.h"
#include "gear_controller.h"
#include "high_pressure_fuel_pump.h"
#include "limp_manager.h"
#include "pin_repository.h"
#include "ac_control.h"
#include "knock_logic.h"
#include "idle_state_generated.h"
#include "sent_state_generated.h"
#include "dc_motors_generated.h"
#include "idle_thread.h"
#include "injector_model.h"
#include "launch_control.h"
#include "antilag_system.h"
#include "trigger_scheduler.h"
#include "fuel_pump.h"
#include "main_relay.h"
#include "ac_control.h"
#include "type_list.h"
#include "boost_control.h"
#include "ignition_controller.h"
#include "alternator_controller.h"
#include "harley_acr.h"
#include "dfco.h"
#include "fuel_computer.h"
#include "gear_detector.h"
#include "advance_map.h"
#include "fan_control.h"
#include "sensor_checker.h"
#include "fuel_schedule.h"
#include "prime_injection.h"
#include "throttle_model.h"
#include "gc_generic.h"
#include "lambda_monitor.h"
#include "efi_output.h"
#include "vvt.h"
#include "trip_odometer.h"
#ifndef EFI_UNIT_TEST
#error EFI_UNIT_TEST must be defined!
#endif
#ifndef EFI_SIMULATOR
#error EFI_SIMULATOR must be defined!
#endif
#ifndef EFI_PROD_CODE
#error EFI_PROD_CODE must be defined!
#endif
struct AirmassModelBase;
#define MAF_DECODING_CACHE_SIZE 256
#define MAF_DECODING_CACHE_MULT (MAF_DECODING_CACHE_SIZE / 5.0)
/**
* I am not sure if this needs to be configurable.
*
* Also technically the whole feature might be implemented as cranking fuel coefficient curve by TPS.
*/
// todo: not great location for these
#define CLEANUP_MODE_TPS 90
#define STEPPER_PARKING_TPS CLEANUP_MODE_TPS
class IEtbController;
class Engine final : public TriggerStateListener {
public:
Engine();
// todo: technical debt: enableOverdwellProtection #3553
bool enableOverdwellProtection = true;
TunerStudioOutputChannels outputChannels;
/**
* Sometimes for instance during shutdown we need to completely supress CAN TX
*/
bool allowCanTx = true;
// used by HW CI
bool isPwmEnabled = true;
const char *prevOutputName = nullptr;
/**
* ELM327 cannot handle both RX and TX at the same time, we have to stay quite once first ISO/TP packet was detected
* this is a pretty temporary hack only while we are trying ELM327, long term ISO/TP and rusEFI broadcast should find a way to coexists
*/
bool pauseCANdueToSerial = false;
PinRepository pinRepository;
IEtbController *etbControllers[ETB_COUNT] = {nullptr};
#if EFI_ENGINE_CONTROL
FuelComputer fuelComputer;
#endif // EFI_ENGINE_CONTROL
type_list<
Mockable<InjectorModelPrimary>,
Mockable<InjectorModelSecondary>,
#if EFI_IDLE_CONTROL
Mockable<IdleController>,
#endif // EFI_IDLE_CONTROL
TriggerScheduler,
#if EFI_HPFP && EFI_ENGINE_CONTROL
HpfpController,
#endif // EFI_HPFP && EFI_ENGINE_CONTROL
#if EFI_ENGINE_CONTROL
Mockable<ThrottleModel>,
#endif // EFI_ENGINE_CONTROL
#if EFI_ALTERNATOR_CONTROL
AlternatorController,
#endif /* EFI_ALTERNATOR_CONTROL */
FuelPumpController,
MainRelayController,
IgnitionController,
Mockable<AcController>,
FanControl1,
FanControl2,
PrimeController,
DfcoController,
#if EFI_HD_ACR
HarleyAcr,
#endif // EFI_HD_ACR
Mockable<WallFuelController>,
#if EFI_VEHICLE_SPEED
GearDetector,
TripOdometer,
#endif // EFI_VEHICLE_SPEED
KnockController,
SensorChecker,
#if EFI_ENGINE_CONTROL
LimpManager,
#endif // EFI_ENGINE_CONTROL
#if EFI_VVT_PID
VvtController1,
VvtController2,
VvtController3,
VvtController4,
#endif // EFI_VVT_PID
#if EFI_BOOST_CONTROL
BoostController,
#endif // EFI_BOOST_CONTROL
EngineModule // dummy placeholder so the previous entries can all have commas
> engineModules;
/**
* Slightly shorter helper function to keep the code looking clean.
*/
template<typename get_t>
constexpr auto & module() {
return engineModules.get<get_t>();
}
#if EFI_TCU
GearControllerBase *gearController;
#endif
SwitchedState clutchUpSwitchedState;
SwitchedState brakePedalSwitchedState;
SwitchedState acButtonSwitchedState;
SimpleSwitchedState luaDigitalInputState[LUA_DIGITAL_INPUT_COUNT];
#if EFI_LAUNCH_CONTROL
LaunchControlBase launchController;
SoftSparkLimiter softSparkLimiter;
// technically not directly related to EFI_LAUNCH_CONTROL since useful for TCU
SoftSparkLimiter hardSparkLimiter;
#endif // EFI_LAUNCH_CONTROL
#if EFI_ANTILAG_SYSTEM
AntilagSystemBase antilagController;
#endif // EFI_ANTILAG_SYSTEM
#if EFI_ANTILAG_SYSTEM
SoftSparkLimiter ALSsoftSparkLimiter;
#endif /* EFI_ANTILAG_SYSTEM */
#if EFI_SHAFT_POSITION_INPUT
LambdaMonitor lambdaMonitor;
#endif // EFI_ENGINE_CONTROL
IgnitionState ignitionState;
void resetLua();
Timer startStopStateLastPush;
#if EFI_SHAFT_POSITION_INPUT
void OnTriggerStateProperState(efitick_t nowNt) override;
void OnTriggerSynchronization(bool wasSynchronized, bool isDecodingError) override;
void OnTriggerSynchronizationLost() override;
#endif
void setConfig();
LocalVersionHolder versionForConfigurationListeners;
AuxActor auxValves[AUX_DIGITAL_VALVE_COUNT][2];
#if EFI_UNIT_TEST
bool needTdcCallback = true;
#endif /* EFI_UNIT_TEST */
int getGlobalConfigurationVersion(void) const;
// a pointer with interface type would make this code nicer but would carry extra runtime
// cost to resolve pointer, we use instances as a micro optimization
#if EFI_SIGNAL_EXECUTOR_ONE_TIMER
SingleTimerExecutor executor;
#endif
#if EFI_SIGNAL_EXECUTOR_SLEEP
SleepExecutor executor;
#endif
#if EFI_UNIT_TEST
TestExecutor executor;
#endif // EFI_UNIT_TEST
#if EFI_ENGINE_CONTROL
FuelSchedule injectionEvents;
IgnitionEventList ignitionEvents;
scheduling_s tdcScheduler[2];
#endif /* EFI_ENGINE_CONTROL */
// todo: move to electronic_throttle something?
bool etbAutoTune = false;
#if EFI_UNIT_TEST
bool tdcMarkEnabled = true;
#endif // EFI_UNIT_TEST
bool slowCallBackWasInvoked = false;
RpmCalculator rpmCalculator;
Timer configBurnTimer;
/**
* This counter is incremented every time user adjusts ECU parameters online (either via rusEfi console or other
* tuning software)
*/
int globalConfigurationVersion = 0;
TpsAccelEnrichment tpsAccelEnrichment;
#if EFI_SHAFT_POSITION_INPUT
TriggerCentral triggerCentral;
#endif // EFI_SHAFT_POSITION_INPUT
float stftCorrection[STFT_BANK_COUNT] = {0};
/**
* See FAST_CALLBACK_PERIOD_MS
*/
void periodicFastCallback();
/**
* See SLOW_CALLBACK_PERIOD_MS
*/
void periodicSlowCallback();
void updateSlowSensors();
void updateSwitchInputs();
void updateTriggerWaveform();
bool isRunningPwmTest = false;
// todo: encapsulate
uint16_t currentEgtValue[EGT_CHANNEL_COUNT];
/**
* are we running any kind of functional test? this affect
* some areas
*/
bool isFunctionalTestMode = false;
void resetEngineSnifferIfInTestMode();
EngineState engineState;
dc_motors_s dc_motors;
sent_state_s sent_state;
/**
* idle blip is a development tool: alternator PID research for instance have benefited from a repetitive change of RPM
*/
percent_t blipIdlePosition;
efitimeus_t timeToStopBlip = 0;
efitimeus_t timeToStopIdleTest = 0;
SensorsState sensors;
void preCalculate();
void efiWatchdog();
void onEngineHasStopped();
/**
* Needed by EFI_MAIN_RELAY_CONTROL to shut down the engine correctly.
* This method cancels shutdown if the ignition voltage is detected.
*/
void checkShutdown();
/**
* Allows to finish some long-term shutdown procedures (stepper motor parking etc.)
Called when the ignition switch is turned off (vBatt is too low).
Returns true if some operations are in progress on background.
*/
bool isInShutdownMode() const;
/**
* The stepper does not work if the main relay is turned off (it requires +12V).
* Needed by the stepper motor code to detect if it works.
*/
bool isMainRelayEnabled() const;
void onSparkFireKnockSense(uint8_t cylinderIndex, efitick_t nowNt);
#if EFI_UNIT_TEST
AirmassModelBase* mockAirmassModel = nullptr;
#endif
private:
void reset();
void injectEngineReferences();
};
trigger_type_e getVvtTriggerType(vvt_mode_e vvtMode);
void applyNonPersistentConfiguration();
void prepareOutputSignals();
// todo: huh we also have validateConfig()?!
void validateConfiguration();
void scheduleReboot();
bool isLockedFromUser();
void unlockEcu(int password);
// These externs aren't needed for unit tests - everything is injected instead
#if !EFI_UNIT_TEST
extern Engine ___engine;
static Engine * const engine = &___engine;
#else // EFI_UNIT_TEST
extern Engine *engine;
#endif // EFI_UNIT_TEST