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_DRIVE_STATE_INVALID = 0, 
  VEHICLE_DRIVE_STATE_NEUTRAL,     
  VEHICLE_DRIVE_STATE_DRIVE,       
  VEHICLE_DRIVE_STATE_REVERSE,     
  /* Extra drive state types used only by motor */
 
  VEHICLE_DRIVE_STATE_CRUISE, 
  VEHICLE_DRIVE_STATE_BRAKE,  
  VEHICLE_DRIVE_STATE_REGEN,  
} VehicleDriveState;
 
typedef enum {
  VEHICLE_POWER_STATE_IDLE,   
  VEHICLE_POWER_STATE_DRIVE,  
  VEHICLE_POWER_STATE_CHARGE, 
  VEHICLE_POWER_STATE_FAULT   
} VehiclePowerStates;
 
/************************************************************************************************
 * Rear Controller Global Definitions
 ************************************************************************************************/
 
typedef enum {
  BPS_FAULT_OVERVOLTAGE,           
  BPS_FAULT_UNBALANCE,             
  BPS_FAULT_OVERTEMP_AMBIENT,      
  BPS_FAULT_COMMS_LOSS_AFE,        
  BPS_FAULT_COMMS_LOSS_CURR_SENSE, 
  BPS_FAULT_OVERTEMP_CELL,         
  BPS_FAULT_OVERCURRENT,           
  BPS_FAULT_UNDERVOLTAGE,          
  BPS_FAULT_KILLSWITCH,            
  BPS_FAULT_RELAY_CLOSE_FAILED,    
  BPS_FAULT_DISCONNECTED,          
  NUM_BPS_FAULTS
} BpsFault;
 
#define BPS_FAULT_OVERVOLTAGE_MASK (1U << BPS_FAULT_OVERVOLTAGE)
#define BPS_FAULT_UNBALANCE_MASK (1U << BPS_FAULT_UNBALANCE)
#define BPS_FAULT_OVERTEMP_AMBIENT_MASK (1U << BPS_FAULT_OVERTEMP_AMBIENT)
#define BPS_FAULT_COMMS_LOSS_AFE_MASK (1U << BPS_FAULT_COMMS_LOSS_AFE)
#define BPS_FAULT_COMMS_LOSS_CURR_SENSE_MASK (1U << BPS_FAULT_COMMS_LOSS_CURR_SENSE)
#define BPS_FAULT_OVERTEMP_CELL_MASK (1U << BPS_FAULT_OVERTEMP_CELL)
#define BPS_FAULT_OVERCURRENT_MASK (1U << BPS_FAULT_OVERCURRENT)
#define BPS_FAULT_UNDERVOLTAGE_MASK (1U << BPS_FAULT_UNDERVOLTAGE)
#define BPS_FAULT_KILLSWITCH_MASK (1U << BPS_FAULT_KILLSWITCH)
#define BPS_FAULT_RELAY_CLOSE_FAILED_MASK (1U << BPS_FAULT_RELAY_CLOSE_FAILED)
#define BPS_FAULT_DISCONNECTED_MASK (1U << BPS_FAULT_DISCONNECTED)
 
#define BPS_FAULT_HIGH_PRIORITY_MASK (1U << 15U)
#define BPS_FAULT_LOW_PRIORITY_MASK (1U << 14U)
 
/************************************************************************************************
 * Steering Global Definitions
 ************************************************************************************************/
 
typedef enum {
  STEERING_LIGHTS_OFF_STATE,    
  STEERING_LIGHTS_LEFT_STATE,   
  STEERING_LIGHTS_RIGHT_STATE,  
  STEERING_LIGHTS_HAZARD_STATE, 
  NUM_STEERING_LIGHTS,          
} SteeringLightState;
 
typedef enum {
  STEERING_CRUISE_CONTROL_DECREASE_BIT = 0, 
  STEERING_CRUISE_CONTROL_INCREASE_BIT,     
  STEERING_CRUISE_CONTROL_TOGGLE_BIT,       
} SteeringCruiseControl;
 
#define STEERING_CC_INCREASE_MASK (1U << EE_STEERING_CC_INCREASE_BIT)
#define STEERING_CC_DECREASE_MASK (1U << EE_STEERING_CC_DECREASE_BIT)
#define 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;