ltc_afe.h

#pragma once
 
/************************************************************************************************
 * @file   ltc_afe.h
 *
 * @brief  Header file for the LTC8611 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 "fsm.h"
#include "ltc_afe_regs.h"
#include "status.h"
 
/* Removes padding, if possible */
#if defined(__GNUC__)
#define _PACKED __attribute__((packed))
#else
#define _PACKED
#endif
 
#define LTC_AFE_MAX_DEVICES 3
 
#define LTC_AFE_MAX_CELLS_PER_DEVICE 12
#define LTC_AFE_MAX_THERMISTORS_PER_DEVICE 8
 
#define LTC_AFE_MAX_CELLS (LTC_AFE_MAX_DEVICES * LTC_AFE_MAX_CELLS_PER_DEVICE)
#define LTC_AFE_MAX_THERMISTORS (LTC_AFE_MAX_DEVICES * LTC_AFE_MAX_THERMISTORS_PER_DEVICE)
 
typedef enum {
  LTC_AFE_ADC_MODE_422KHZ = 0,
  LTC_AFE_ADC_MODE_27KHZ, 
  LTC_AFE_ADC_MODE_7KHZ,  
  LTC_AFE_ADC_MODE_26HZ,  
  LTC_AFE_ADC_MODE_1KHZ,
  LTC_AFE_ADC_MODE_14KHZ,
  LTC_AFE_ADC_MODE_3KHZ,
  LTC_AFE_ADC_MODE_2KHZ,
  NUM_LTC_AFE_ADC_MODES
} LtcAfeAdcMode;
 
typedef struct LtcAfeSettings {
  LtcAfeAdcMode adc_mode; 
  uint16_t cell_bitset[LTC_AFE_MAX_DEVICES]; 
  uint16_t aux_bitset[LTC_AFE_MAX_DEVICES];  
  size_t num_devices;     
  size_t num_cells;       
  size_t num_thermistors; 
  SpiSettings spi_settings; 
  const SpiPort spi_port;   
} LtcAfeSettings;
 
typedef struct LtcAfeStorage {
  uint16_t cell_voltages[LTC_AFE_MAX_CELLS];      
  uint16_t aux_voltages[LTC_AFE_MAX_THERMISTORS]; 
  uint16_t cell_result_lookup[LTC_AFE_MAX_CELLS];      
  uint16_t aux_result_lookup[LTC_AFE_MAX_THERMISTORS]; 
  uint16_t discharge_cell_lookup[LTC_AFE_MAX_CELLS];   
  LtcAfeSettings *settings;                
  LtcAfeWriteConfigPacket *device_configs; 
} LtcAfeStorage;
 
StatusCode ltc_afe_init(LtcAfeStorage *afe, const LtcAfeSettings *config);
 
StatusCode ltc_afe_write_config(LtcAfeStorage *afe);
 
StatusCode ltc_afe_trigger_cell_conv(LtcAfeStorage *afe);
 
StatusCode ltc_afe_trigger_aux_conv(LtcAfeStorage *afe, uint8_t device_cell);
 
StatusCode ltc_afe_read_cells(LtcAfeStorage *afe);
 
StatusCode ltc_afe_read_aux(LtcAfeStorage *afe, uint8_t device_cell);
 
StatusCode ltc_afe_toggle_cell_discharge(LtcAfeStorage *afe, uint16_t cell, bool discharge);
 
StatusCode ltc_afe_set_discharge_pwm_cycle(LtcAfeStorage *afe, uint8_t duty_cycle);