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 recomended to install the SimplyAtomic library rather than relying on the built-in ATOMIC
#endif
 
using byte = uint8_t;
 
//Define bit positions within engine variable
#define BIT_ENGINE_RUN      0   // Engine running
#define BIT_ENGINE_CRANK    1   // Engine cranking
#define BIT_ENGINE_ASE      2   // after start enrichment (ASE)
#define BIT_ENGINE_WARMUP   3   // Engine in warmup
#define BIT_ENGINE_ACC      4   // in acceleration mode (TPS accel)
#define BIT_ENGINE_DCC      5   // in deceleration mode
#define BIT_ENGINE_MAPACC   6   // MAP acceleration mode
#define BIT_ENGINE_MAPDCC   7   // MAP deceleration mode
 
// Bit masks for statuses::status1
#define BIT_STATUS1_INJ1           0  //inj1
#define BIT_STATUS1_INJ2           1  //inj2
#define BIT_STATUS1_INJ3           2  //inj3
#define BIT_STATUS1_INJ4           3  //inj4
#define BIT_STATUS1_DFCO           4  //Deceleration fuel cutoff
#define BIT_STATUS1_BOOSTCUT       5  //Fuel component of MAP based boost cut out
#define BIT_STATUS1_TOOTHLOG1READY 6  //Used to flag if tooth log 1 is ready
#define BIT_STATUS1_TOOTHLOG2READY 7  //Used to flag if tooth log 2 is ready (Log is not currently used)
 
// Bit masks for statuses::status2
#define BIT_STATUS2_HLAUNCH         0  //Hard Launch indicator
#define BIT_STATUS2_SLAUNCH         1  //Soft Launch indicator
#define BIT_STATUS2_HRDLIM          2  //Hard limiter indicator
#define BIT_STATUS2_SFTLIM          3  //Soft limiter indicator
#define BIT_STATUS2_BOOSTCUT        4  //Spark component of MAP based boost cut out
#define BIT_STATUS2_ERROR           5  // Error is detected
#define BIT_STATUS2_IDLE            6  // idle on
#define BIT_STATUS2_SYNC            7  // Whether engine has sync or not
 
// Bit masks for statuses::status3
#define BIT_STATUS3_RESET_PREVENT 0 //Indicates whether reset prevention is enabled
#define BIT_STATUS3_NITROUS       1
#define BIT_STATUS3_FUEL2_ACTIVE  2
#define BIT_STATUS3_VSS_REFRESH   3
#define BIT_STATUS3_HALFSYNC      4 //shows if there is only sync from primary trigger, but not from secondary.
#define BIT_STATUS3_NSQUIRTS1     5 // Uses bits 5-7
 
// Bit masks for statuses::status4
#define BIT_STATUS4_WMI_EMPTY     0 //Indicates whether the WMI tank is empty
#define BIT_STATUS4_VVT1_ERROR    1 //VVT1 cam angle within limits or not
#define BIT_STATUS4_VVT2_ERROR    2 //VVT2 cam angle within limits or not
#define BIT_STATUS4_FAN           3 //Fan Status
#define BIT_STATUS4_BURNPENDING   4
#define BIT_STATUS4_STAGING_ACTIVE 5
#define BIT_STATUS4_COMMS_COMPAT  6
#define BIT_STATUS4_ALLOW_LEGACY_COMMS       7
 
// Bit masks for statuses::status5
#define BIT_STATUS5_FLATSH         0  //Flat shift hard cut
#define BIT_STATUS5_FLATSS         1  //Flat shift soft cut
#define BIT_STATUS5_SPARK2_ACTIVE  2
#define BIT_STATUS5_KNOCK_ACTIVE   3
#define BIT_STATUS5_KNOCK_PULSE    4
#define BIT_STATUS5_CLUTCH_PRESS   5
#define BIT_STATUS5_UNUSED7        6
#define BIT_STATUS5_UNUSED8        7
 
#define BIT_AIRCON_REQUEST        0 //Indicates whether the A/C button is pressed
#define BIT_AIRCON_COMPRESSOR     1 //Indicates whether the A/C compressor is running
#define BIT_AIRCON_RPM_LOCKOUT    2 //Indicates the A/C is locked out due to the RPM being too high/low, or the post-high/post-low-RPM "stand-down" lockout period
#define BIT_AIRCON_TPS_LOCKOUT    3 //Indicates the A/C is locked out due to high TPS, or the post-high-TPS "stand-down" lockout period
#define BIT_AIRCON_TURNING_ON     4 //Indicates the A/C request is on (i.e. A/C button pressed), the lockouts are off, however the start delay has not yet elapsed. This gives the idle up time to kick in before the compressor.
#define BIT_AIRCON_CLT_LOCKOUT    5 //Indicates the A/C is locked out either due to high coolant temp.
#define BIT_AIRCON_FAN            6 //Indicates whether the A/C fan is running
#define BIT_AIRCON_UNUSED8        7
 
#define ENGINE_PROTECT_BIT_RPM  0
#define ENGINE_PROTECT_BIT_MAP  1
#define ENGINE_PROTECT_BIT_OIL  2
#define ENGINE_PROTECT_BIT_AFR  3
#define ENGINE_PROTECT_BIT_COOLANT 4
 
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
  bool initialisationComplete : 1; 
  // cppcheck-suppress misra-c2012-6.1
  bool clutchTrigger : 1;
  // cppcheck-suppress misra-c2012-6.1
  bool previousClutchTrigger : 1;
  // cppcheck-suppress misra-c2012-6.1
  volatile bool fpPrimed : 1; 
  // cppcheck-suppress misra-c2012-6.1
  volatile bool injPrimed : 1; 
  // cppcheck-suppress misra-c2012-6.1
  volatile bool tachoSweepEnabled : 1;
  // cppcheck-suppress misra-c2012-6.1
  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; 
  volatile byte status1; 
  volatile byte status2;   
  volatile byte status3; 
  volatile byte status4; 
  volatile byte status5;  
  uint8_t engine; 
  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; 
  uint16_t freeRAM;
  unsigned int clutchEngagedRPM; 
  bool flatShiftingHard;
  volatile uint32_t startRevolutions; 
  uint16_t boostTarget;
  byte testOutputs;   
  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;  
  byte nChannels; 
  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;  
  byte engineProtectStatus;
  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;
  byte TS_SD_Status; //TunerStudios SD card status
  byte airConStatus;
  uint8_t systemTemp;
};
 
static inline bool HasAnySyncUnsafe(const statuses &status) {
  return status.hasSync || BIT_CHECK(status.status3, BIT_STATUS3_HALFSYNC);
}
 
static inline bool HasAnySync(const statuses &status) {
  ATOMIC() {
    return HasAnySyncUnsafe(status);
  }
  return false; // Just here to avoid compiler warning.
}