statuses.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include "bit_manip.h"
#include "maths.h"
#include "decoder_t.h"
 
// Forward declares
struct config4;
 
using byte = uint8_t;
 
constexpr uint8_t BIT_TIMER_1HZ = 0;
constexpr uint8_t BIT_TIMER_4HZ = 1;
constexpr uint8_t BIT_TIMER_10HZ = 2;
constexpr uint8_t BIT_TIMER_15HZ = 3;
constexpr uint8_t BIT_TIMER_30HZ = 4;
constexpr uint8_t BIT_TIMER_50HZ = 5;
constexpr uint8_t BIT_TIMER_200HZ = 6;
constexpr uint8_t BIT_TIMER_1KHZ = 7;
 
enum class SchedulerCutStatus : uint8_t
{
  None, 
  Rolling, 
  Full, 
};
 
 
enum class EngineRotationStatus : uint8_t
{
  Stopped, 
  Cranking, 
  Running, 
};
 
struct vvtStatus_t
{
  bool angleError : 1;  
  int16_t angle = 0;        
  uint8_t targetAngle = 0;  
  uint8_t duty = 0;         
 
  vvtStatus_t()
  : angleError(false)
  {
  }
};
 
struct num_injector_t
{
  uint8_t primary : 4; 
  uint8_t secondary : 4; 
  uint8_t getTotalInjectors(void) const
  {
    return primary + secondary;
  }
  bool isPrimaryInjector(uint8_t channel) const
  {
    return channel>0 && channel<=primary;
  }
  bool isSecondaryInjector(uint8_t channel) const
  {
    return channel>primary && channel<=getTotalInjectors();
  }
};
 
struct airConStatus_t
{
  bool acRequested : 1; 
  bool compressorOn : 1; 
  bool rpmLockoutActive : 1; 
  bool tpsLockoutActive : 1; 
  bool turningOn : 1;  
  bool cltLockoutActive : 1;  
  bool fanOn : 1;  
 
  bool isLockoutActive(void) const
  {
    return rpmLockoutActive
        || tpsLockoutActive
        || cltLockoutActive
        ;
  }
};
 
struct launchStatus_t
{
  bool launchingSoft : 1;
  bool launchingHard : 1;
  bool flatShiftingHard : 1;
  bool flatShiftingSoft : 1;
  bool previousClutchTrigger : 1;
  bool clutchTrigger : 1;
  uint16_t clutchEngagedRPM = 0; 
 
  launchStatus_t()
  : launchingSoft(false)
  , launchingHard(false)
  , flatShiftingHard(false)
  , flatShiftingSoft(false)
  , previousClutchTrigger(false)
  , clutchTrigger(false)
  {
  }
};
 
struct statuses {
  statuses(void);
 
#if defined(UNIT_TEST)
  void setRpm(uint16_t rpm);
#endif
 
  void setRevolutionTime(uint32_t revTime);
 
  bool isFixedCrankingIgnitionTimingActive(const config4 &page4) const;
 
  // 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.
  volatile bool injPrimed : 1; 
    
  uint16_t RPM;   
  byte RPMdiv100; 
  uint16_t baroADC;
  uint16_t 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 AEStartTime; 
  // 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.
  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; 
 
  // 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; 
 
  // Status3 fields as defined in the INI.   
  // 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; 
 
  // 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 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; 
 
  // 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;  
 
  // 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; 
  EngineRotationStatus rotationStatus;
  
  volatile byte runSecs; 
  volatile byte secl; 
  volatile uint16_t loopsPerSecond; 
  // TODO: remove this: only updated & read in logger
  uint16_t freeRAM;
  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]; 
  uint16_t crankRPM = 400; 
  int16_t flexBoostCorrection; 
  byte nitrous_status;
  byte nSquirts;  
  uint16_t fuelLoad;
  uint16_t ignLoad;
  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
  uint16_t injAngle;
  byte ASEValue;
  uint16_t vss;      
  bool idleUpOutputActive; 
  byte gear;         
  byte fuelPressure; 
  byte oilPressure;  
  struct engine_protect_flags_t
  {
    // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
    bool rpm : 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 coolant : 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 boostCut : 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 oil : 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 afr : 1; 
 
    // cppcheck-suppress misra-c2012-8.10 ; False positive - cannot make this static
    inline bool isActive(void) const {
      return rpm
            || coolant
            || boostCut
            || oil
            || afr
            ;
    }
 
    // cppcheck-suppress misra-c2012-8.10 ; False positive - cannot make this static
    inline void reset(void) {
      rpm = false;
      boostCut = false;
      oil = false;
      afr = false;
      coolant = false;
    }  
  };
  engine_protect_flags_t engineProtect;
  // cppcheck-suppress misra-c2012-6.1 ; False positive - MISRA C:2012 Rule (R 6.1) permits the use of boolean for bit fields.
  bool ioError : 1; 
 
  byte fanDuty;
  byte wmiPW;
 
  // 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_t acStatus = {};
  
  uint8_t systemTemp;
  uint32_t revolutionTime; //The time in uS that one revolution would take at current speed (The time tooth 1 was last seen, minus the time it was seen prior to that). Zero if the speed is unknown
 
  uint8_t maxIgnOutputs; 
  uint8_t injLayout : 3; 
  num_injector_t injOutputs;
  
  struct scheduler_cut_t
  {
    // Using bytes for compactness ATM, but that limits us to 8 fuel and 
    // 8 ignition channels
    byte ignitionChannelsPending = 0; 
    byte ignitionChannels = 0xFF; 
    byte fuelChannels = 0xFF; 
    SchedulerCutStatus status = SchedulerCutStatus::None;
  };
  scheduler_cut_t schedulerCutState;
 
  decoder_t decoder; 
 
  uint8_t LOOP_TIMER; 
 
  vvtStatus_t vvt1;
  vvtStatus_t vvt2;
 
  launchStatus_t launchStatus;
};