global_enums.h

#pragma once
 
/************************************************************************************************
 * @file   global_enums.h
 *
 * @brief  Header file for global enums which are exported between projects with CAN
 *
 * @date   2025-01-12
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
 
/************************************************************************************************
 * Shared Global definitions
 ************************************************************************************************/
 
typedef enum {
  VEHICLE_NEUTRAL, 
  VEHICLE_DRIVE,   
  VEHICLE_REVERSE, 
  /* Extra drive state types used only by motor */
 
  VEHICLE_CRUISE, 
  VEHICLE_BRAKE,  
} DriveState;
 
/************************************************************************************************
 * BMS Global Definitions
 ************************************************************************************************/
 
typedef enum {
  BMS_RELAY_STATE_CLOSE, 
  BMS_RELAY_STATE_FAULT, 
  NUM_BMS_RELAY_STATES,  
} BmsRelayState;
 
typedef enum {
  BMS_FAULT_OVERVOLTAGE,           
  BMS_FAULT_UNBALANCE,             
  BMS_FAULT_OVERTEMP_AMBIENT,      
  BMS_FAULT_COMMS_LOSS_AFE,        
  BMS_FAULT_COMMS_LOSS_CURR_SENSE, 
  BMS_FAULT_OVERTEMP_CELL,         
  BMS_FAULT_OVERCURRENT,           
  BMS_FAULT_UNDERVOLTAGE,          
  BMS_FAULT_KILLSWITCH,            
  BMS_FAULT_RELAY_CLOSE_FAILED,    
  BMS_FAULT_DISCONNECTED           
} BmsFault;
 
#define BMS_FAULT_OVERVOLTAGE_MASK (1U << BMS_FAULT_OVERVOLTAGE)
#define BMS_FAULT_UNBALANCE_MASK (1U << BMS_FAULT_UNBALANCE)
#define BMS_FAULT_OVERTEMP_AMBIENT_MASK (1U << BMS_FAULT_OVERTEMP_AMBIENT)
#define BMS_FAULT_COMMS_LOSS_AFE_MASK (1U << BMS_FAULT_COMMS_LOSS_AFE)
#define BMS_FAULT_COMMS_LOSS_CURR_SENSE_MASK (1U << BMS_FAULT_COMMS_LOSS_CURR_SENSE)
#define BMS_FAULT_OVERTEMP_CELL_MASK (1U << BMS_FAULT_OVERTEMP_CELL)
#define BMS_FAULT_OVERCURRENT_MASK (1U << BMS_FAULT_OVERCURRENT)
#define BMS_FAULT_UNDERVOLTAGE_MASK (1U << BMS_FAULT_UNDERVOLTAGE)
#define BMS_FAULT_KILLSWITCH_MASK (1U << BMS_FAULT_KILLSWITCH)
#define BMS_FAULT_RELAY_CLOSE_FAILED_MASK (1U << BMS_FAULT_RELAY_CLOSE_FAILED)
#define BMS_FAULT_DISCONNECTED_MASK (1U << BMS_FAULT_DISCONNECTED)
 
#define BMS_FAULT_HIGH_PRIORITY_MASK (1U << 15U)
#define BMS_FAULT_LOW_PRIORITY_MASK (1U << 14U)
 
/************************************************************************************************
 * Centre Console Global Definitions
 ************************************************************************************************/
 
typedef enum {
  CC_STEERING_LIGHTS_OFF_STATE,   
  CC_STEERING_LIGHTS_LEFT_STATE,  
  CC_STEERING_LIGHTS_RIGHT_STATE, 
  NUM_EE_STEERING_LIGHTS,         
} CCSteeringLights;
 
typedef enum {
  CC_STEERING_CRUISE_CONTROL_DECREASE_BIT = 0, 
  CC_STEERING_CRUISE_CONTROL_INCREASE_BIT,     
  CC_STEERING_CRUISE_CONTROL_TOGGLE_BIT,       
} CCSteeringCruiseControl;
 
#define EE_STEERING_CC_INCREASE_MASK (1U << EE_STEERING_CC_INCREASE_BIT)
#define EE_STEERING_CC_DECREASE_MASK (1U << EE_STEERING_CC_DECREASE_BIT)
#define EE_STEERING_CC_TOGGLE_MASK (1U << EE_STEERING_CC_TOGGLE_BIT)
 
/************************************************************************************************
 * Power Distribution Global Definitions
 ************************************************************************************************/
 
typedef enum {
  EE_POWER_OFF_STATE,       
  EE_POWER_PRECHARGE_STATE, 
  EE_POWER_DRIVE_STATE,     
  EE_POWER_FAULT_STATE      
} PDPowerState;