adbms_afe.h

#pragma once
 
/************************************************************************************************
 * @file   adbms_afe.h
 *
 * @brief  Header file for the ADBMS1818 AFE driver
 *
 * @date   2025-04-13
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <assert.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
 
/* Inter-component Headers */
#include "gpio.h"
#include "spi.h"
 
/* Intra-component Headers */
#include "adbms_afe_regs.h"
#include "status.h"
 
/* Removes padding, if possible */
#if defined(__GNUC__)
#define _PACKED __attribute__((packed))
#else
#define _PACKED
#endif
 
#define ADBMS_AFE_MAX_DEVICES 3
 
#define ADBMS_AFE_MAX_CELLS_PER_DEVICE 18
#define ADBMS_AFE_MAX_CELL_THERMISTORS_PER_DEVICE 16
#define ADBMS_AFE_MAX_BOARD_THERMISTORS_PER_DEVICE 1
 
#define ADBMS_AFE_MAX_CELLS (ADBMS_AFE_MAX_DEVICES * ADBMS_AFE_MAX_CELLS_PER_DEVICE)
#define ADBMS_AFE_MAX_CELL_THERMISTORS (ADBMS_AFE_MAX_DEVICES * ADBMS_AFE_MAX_CELL_THERMISTORS_PER_DEVICE)
#define ADBMS_AFE_MAX_BOARD_THERMISTORS (ADBMS_AFE_MAX_DEVICES * ADBMS_AFE_MAX_CELL_THERMISTORS_PER_DEVICE)
 
typedef enum {
  ADBMS_AFE_ADC_MODE_422HZ = 0,
  ADBMS_AFE_ADC_MODE_27KHZ, 
  ADBMS_AFE_ADC_MODE_7KHZ,  
  ADBMS_AFE_ADC_MODE_26HZ,  
  ADBMS_AFE_ADC_MODE_1KHZ,
  ADBMS_AFE_ADC_MODE_14KHZ,
  ADBMS_AFE_ADC_MODE_3KHZ,
  ADBMS_AFE_ADC_MODE_2KHZ,
  NUM_ADBMS_AFE_ADC_MODES
} AdbmsAfeAdcMode;
 
typedef struct AdbmsAfeSettings {
  AdbmsAfeAdcMode adc_mode; 
  uint16_t cell_bitset[ADBMS_AFE_MAX_DEVICES]; 
  size_t num_devices;     
  size_t num_cells;       
  size_t num_thermistors; 
  SpiSettings *spi_settings; 
  const SpiPort spi_port;    
} AdbmsAfeSettings;
 
typedef struct AdbmsAfeStorage {
  uint16_t cell_voltages[ADBMS_AFE_MAX_CELLS];                         
  uint16_t thermistor_voltages[ADBMS_AFE_MAX_CELL_THERMISTORS];        
  uint16_t board_thermistor_voltages[ADBMS_AFE_MAX_BOARD_THERMISTORS]; 
  uint16_t cell_result_lookup[ADBMS_AFE_MAX_CELLS];    
  uint16_t discharge_cell_lookup[ADBMS_AFE_MAX_CELLS]; 
  AdbmsAfeSettings *settings;                                 
  AdbmsAfeWriteConfigAPacket config_a[ADBMS_AFE_MAX_DEVICES]; 
  AdbmsAfeWriteConfigBPacket config_b[ADBMS_AFE_MAX_DEVICES]; 
} AdbmsAfeStorage;
 
StatusCode adbms_afe_init(AdbmsAfeStorage *afe, const AdbmsAfeSettings *config);
 
StatusCode adbms_afe_write_config(AdbmsAfeStorage *afe);
 
StatusCode adbms_afe_trigger_cell_conv(AdbmsAfeStorage *afe);
 
StatusCode adbms_afe_trigger_thermistor_conv(AdbmsAfeStorage *afe, uint8_t device_num, uint8_t thermistor_index);
 
StatusCode adbms_afe_trigger_board_temp_conv(AdbmsAfeStorage *afe, uint8_t device_num);
 
StatusCode adbms_afe_read_cells(AdbmsAfeStorage *afe);
 
StatusCode adbms_afe_read_thermistor(AdbmsAfeStorage *afe, uint8_t device_num, uint8_t thermistor_index);
 
StatusCode adbms_afe_read_board_temp(AdbmsAfeStorage *afe, uint8_t device_num);
 
StatusCode adbms_afe_toggle_cell_discharge(AdbmsAfeStorage *afe, uint16_t cell, bool discharge);
 
StatusCode adbms_afe_set_discharge_pwm_cycle(AdbmsAfeStorage *afe, uint8_t duty_cycle);
 
#ifdef MS_PLATFORM_X86
 
AdbmsAfeStorage *adbms_afe_get_storage(void);
 
StatusCode adbms_afe_set_cell_voltage(AdbmsAfeStorage *afe, uint8_t cell_index, float voltage);
 
StatusCode adbms_afe_set_thermistor_voltage(AdbmsAfeStorage *afe, uint8_t device_num, uint8_t thermistor_index, float voltage);
 
StatusCode adbms_afe_set_board_thermistor_voltage(AdbmsAfeStorage *afe, uint8_t device_num, float voltage);
 
StatusCode adbms_afe_set_afe_dev_cell_voltages(AdbmsAfeStorage *afe, size_t device_num, float voltage);
 
StatusCode adbms_afe_set_afe_dev_thermistor_voltages(AdbmsAfeStorage *afe, size_t device_num, float voltage);
 
StatusCode adbms_afe_set_pack_cell_voltages(AdbmsAfeStorage *afe, float voltage);
 
StatusCode adbms_afe_set_pack_thermistor_voltages(AdbmsAfeStorage *afe, float voltage);
 
StatusCode adbms_afe_set_pack_board_thermistor_voltages(AdbmsAfeStorage *afe, float voltage);
 
uint16_t adbms_afe_get_cell_voltage(AdbmsAfeStorage *afe, uint16_t cell_index);
 
uint16_t adbms_afe_get_thermistor_voltage(AdbmsAfeStorage *afe, uint8_t device_num, uint16_t thermistor_index);
 
uint16_t adbms_afe_get_board_thermistor_voltage(AdbmsAfeStorage *afe, uint8_t device_num);
 
bool adbms_afe_get_cell_discharge(AdbmsAfeStorage *afe, uint16_t cell);
#endif