statuses.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include "bit_manip.h"
 
#if __has_include(<SimplyAtomic.h>)
  #include <SimplyAtomic.h>
#else 
  //Fallback for Arduino IDE when SimplyAtomic is not installed
  #include <util/atomic.h>
  #define ATOMIC() ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
  #warning It is strongly recommended to install the SimplyAtomic library rather than relying on the built-in ATOMIC
#endif
 
using byte = uint8_t;
 
struct statuses {
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool hasSync : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool initialisationComplete : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool clutchTrigger : 1;
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool previousClutchTrigger : 1;
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool fpPrimed : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool injPrimed : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool tachoSweepEnabled : 1;
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool tachoAlt : 1;
    
  uint16_t RPM;   
  byte RPMdiv100; 
  long longRPM;   
  uint16_t baroADC;
  long MAP;     
  uint16_t EMAP; 
  uint8_t baro;   
  uint8_t TPS;    
  uint8_t tpsADC; 
  int16_t tpsDOT; 
  byte TPSlast; 
  int16_t mapDOT; 
  volatile int rpmDOT; 
  byte VE;     
  byte VE1;    
  byte VE2;    
  uint8_t O2;     
  uint8_t O2_2;   
  int coolant; 
  uint16_t cltADC;
  int IAT;     
  uint16_t iatADC;
  uint16_t O2ADC;
  uint16_t O2_2ADC;
  uint16_t dwell;          
  volatile uint16_t actualDwell;    
  byte dwellCorrection; 
  byte battery10;     
  int8_t advance;     
  int8_t advance1;    
  int8_t advance2;    
  uint16_t corrections; 
  uint16_t AEamount;    
  byte egoCorrection; 
  byte wueCorrection; 
  byte batCorrection; 
  byte iatCorrection; 
  byte baroCorrection; 
  byte launchCorrection;   
  byte flexCorrection;     
  byte fuelTempCorrection; 
  int8_t flexIgnCorrection;
  byte afrTarget;    
  byte CLIdleTarget; 
  bool idleUpActive; 
  bool CTPSActive;   
  volatile byte ethanolPct; 
  volatile int8_t fuelTemp;
  unsigned long AEEndTime; 
  // Status1 fields as defined in the INI
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool isInj1Open : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool isInj2Open : 1; 
  // cppcheck-suppress misra-c2012-6.1
  volatile bool isInj3Open : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool isInj4Open : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool isDFCOActive : 1;  
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool isToothLog1Full : 1; 
 
  // Status2 fields as defined in the INI. 
  // TODO: resolve duplication with launchingHard
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool hardLaunchActive : 1; 
  // TODO: resolve duplication with launchingSoft
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool softLaunchActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool hardLimitActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool softLimitActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool idleOn : 1; 
  // TODO: resolve duplication with hasSync
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool hasFullSync : 1; // Whether engine has sync (true) or not (false)
 
  // Status3 fields as defined in the INI.   
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool resetPreventActive : 1; 
  // TODO: resolve duplication with nitrous_status
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool nitrousActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool secondFuelTableActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool vssUiRefresh : 1; 
  // TODO: resolve duplication with hasSync & hasFullSync
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  volatile bool halfSync : 1;  
  // TODO: resolve duplication with nSquirts
  unsigned int nSquirtsStatus: 3; 
 
  // Status4 fields as defined in the INI.   
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool wmiTankEmpty : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool vvt1AngleError : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool vvt2AngleError : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool fanOn : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool burnPending : 1;  
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool stagingActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool commCompat : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool allowLegacyComms : 1; 
 
  // Status5 fields as defined in the INI. 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool flatShiftSoftCut : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool secondSparkTableActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool knockRetardActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool knockPulseDetected : 1;  
  // TODO: resolve duplication with clutchTrigger
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool clutchTriggerActive : 1; 
 
  // Engine status fields as defined in the INI.  
  // TODO: engine has 3 states: Off, Cranking, Running. Need to capture this better 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool engineIsRunning : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool engineIsCranking : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool aseIsActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool wueIsActive : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  // TODO: acceleration has 3 states: Steady, Accelerating, Decelerating. Need to capture this better 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool isAcceleratingTPS : 1;  
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool isDeceleratingTPS : 1; 
  
  // TODO: make all pulse widths uint16_t
  unsigned int PW1; 
  unsigned int PW2; 
  unsigned int PW3; 
  unsigned int PW4; 
  unsigned int PW5; 
  unsigned int PW6; 
  unsigned int PW7; 
  unsigned int PW8; 
  volatile byte runSecs; 
  volatile byte secl; 
  volatile uint16_t loopsPerSecond; 
  bool launchingSoft; 
  bool launchingHard; 
  // TODO: remove this: only updated & read in logger
  uint16_t freeRAM;
  // TODO: make all RPMs uint16_t
  unsigned int clutchEngagedRPM; 
  bool flatShiftingHard;
  volatile uint32_t startRevolutions; 
  uint16_t boostTarget;
  // TODO: resolve conflict with testActive
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool isTestModeActive : 1; // Is hardware test mode on?
  bool testActive;    // Not in use ? Replaced by testOutputs ?
  uint16_t boostDuty; 
  byte idleLoad;      
  uint16_t canin[16]; 
  uint8_t current_caninchannel = 0; 
  uint16_t crankRPM = 400; 
  int16_t flexBoostCorrection; 
  byte nitrous_status;
  byte nSquirts;  
  uint16_t fuelLoad;
  uint16_t ignLoad;
  bool fuelPumpOn; 
  volatile byte syncLossCounter;
  byte knockRetard;
  volatile byte knockCount;
  bool toothLogEnabled;
  byte compositeTriggerUsed; // 0 means composite logger disabled, 2 means use secondary input (1st cam), 3 means use tertiary input (2nd cam), 4 means log both cams together
  int16_t vvt1Angle; //Has to be a long for PID calcs (CL VVT control)
  byte vvt1TargetAngle;
  long vvt1Duty; //Has to be a long for PID calcs (CL VVT control)
  uint16_t injAngle;
  byte ASEValue;
  uint16_t vss;      
  bool idleUpOutputActive; 
  byte gear;         
  byte fuelPressure; 
  byte oilPressure;  
  // engineProtectStatus fields as defined in the INI. Needs to be accessible as a byte for I/O, so use type punning.
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool engineProtectRpm : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool engineProtectBoostCut : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool engineProtectOil : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool engineProtectAfr : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool engineProtectClt : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool engineProtectIoError : 1; 
 
  byte fanDuty;
  byte wmiPW;
  int16_t vvt2Angle; //Has to be a long for PID calcs (CL VVT control)
  byte vvt2TargetAngle;
  long vvt2Duty; //Has to be a long for PID calcs (CL VVT control)
  byte outputsStatus;
 
  // SD card status fields.
  // TODO: conditional compile on SD_LOGGING once board definition is separated from globals.h
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool sdCardPresent : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  unsigned int sdCardType : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool sdCardReady : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool sdCardLogging : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool sdCardError : 1;  
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  unsigned int sdCardFS : 1;  
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool sdCardUnused : 1;  
 
  // airConStatus fields.
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool airconRequested : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool airconCompressorOn : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool airconRpmLockout : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool airconTpsLockout : 1; 
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool airconTurningOn : 1;  
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool airconCltLockout : 1;  
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool airconFanOn : 1;  
  
  uint8_t systemTemp;
};
 
static inline bool HasAnySyncUnsafe(const statuses &status) {
  return status.hasSync || status.halfSync;
}
 
static inline bool HasAnySync(const statuses &status) {
  ATOMIC() {
    return HasAnySyncUnsafe(status);
  }
  return false; // Just here to avoid compiler warning.
}
 
static inline bool isEngineProtectActive(const statuses &status) {
  return status.engineProtectRpm
        || status.engineProtectBoostCut
        || status.engineProtectOil
        || status.engineProtectAfr
        || status.engineProtectClt;
}
 
static inline void resetEngineProtect(statuses &status) {
  status.engineProtectRpm = false;
  status.engineProtectBoostCut = false;
  status.engineProtectOil = false;
  status.engineProtectAfr = false;
  status.engineProtectClt = false;
  status.engineProtectIoError = false;
}