ltc_afe_regs.h

#pragma once
 
/************************************************************************************************
 * @file   ltc_afe_regs.h
 *
 * @brief  Header file to define the LTC8611 AFE's register layout, configuration, and command code structures
 *
 * @date   2025-04-13
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <assert.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
 
#if defined(__GNUC__)
#define _PACKED __attribute__((packed))
#else
#define _PACKED
#endif
 
#define LTC6811_CELLS_IN_REG 3
#define LTC6811_GPIOS_IN_REG 3
 
#define AUX_ADG731_NUM_PINS 32
 
#define LTC6811_CMD_SIZE 4
 
#define LTC6811_NUM_COMM_REG_BYTES 3
 
#define LTC8611_NUM_PWM_REGS 6
 
#define LTC_AFE_MAX_CELLS_PER_DEVICE 12
typedef enum {
  LTC_AFE_REGISTER_CONFIG = 0,     
  LTC_AFE_REGISTER_CELL_VOLTAGE_A, 
  LTC_AFE_REGISTER_CELL_VOLTAGE_B, 
  LTC_AFE_REGISTER_CELL_VOLTAGE_C, 
  LTC_AFE_REGISTER_CELL_VOLTAGE_D, 
  LTC_AFE_REGISTER_AUX_A,          
  LTC_AFE_REGISTER_AUX_B,          
  LTC_AFE_REGISTER_STATUS_A,       
  LTC_AFE_REGISTER_STATUS_B,       
  LTC_AFE_REGISTER_READ_COMM,      
  LTC_AFE_REGISTER_START_COMM,     
  NUM_LTC_AFE_REGISTERS            
} LtcAfeRegister;
 
typedef enum {
  LTC_AFE_VOLTAGE_REGISTER_A = LTC_AFE_REGISTER_CELL_VOLTAGE_A,
  LTC_AFE_VOLTAGE_REGISTER_B = LTC_AFE_REGISTER_CELL_VOLTAGE_B,
  LTC_AFE_VOLTAGE_REGISTER_C = LTC_AFE_REGISTER_CELL_VOLTAGE_C,
  LTC_AFE_VOLTAGE_REGISTER_D = LTC_AFE_REGISTER_CELL_VOLTAGE_D,
  NUM_LTC_AFE_VOLTAGE_REGISTERS
} LtcAfeVoltageRegister;
 
typedef enum {
  LTC_AFE_DISCHARGE_TIMEOUT_DISABLED = 0, 
  LTC_AFE_DISCHARGE_TIMEOUT_30_S,         
  LTC_AFE_DISCHARGE_TIMEOUT_1_MIN,        
  LTC_AFE_DISCHARGE_TIMEOUT_2_MIN,        
  LTC_AFE_DISCHARGE_TIMEOUT_3_MIN,        
  LTC_AFE_DISCHARGE_TIMEOUT_4_MIN,        
  LTC_AFE_DISCHARGE_TIMEOUT_5_MIN,        
  LTC_AFE_DISCHARGE_TIMEOUT_10_MIN,       
  LTC_AFE_DISCHARGE_TIMEOUT_15_MIN,       
  LTC_AFE_DISCHARGE_TIMEOUT_20_MIN,       
  LTC_AFE_DISCHARGE_TIMEOUT_30_MIN,       
  LTC_AFE_DISCHARGE_TIMEOUT_40_MIN,       
  LTC_AFE_DISCHARGE_TIMEOUT_60_MIN,       
  LTC_AFE_DISCHARGE_TIMEOUT_75_MIN,       
  LTC_AFE_DISCHARGE_TIMEOUT_90_MIN,       
  LTC_AFE_DISCHARGE_TIMEOUT_120_MIN       
} LtcAfeDischargeTimeout;
 
typedef struct {
  uint8_t adcopt : 1; 
  uint8_t dten : 1;   
  uint8_t refon : 1;  
  uint8_t gpio : 5; 
  uint32_t undervoltage : 12; 
  uint32_t overvoltage : 12;  
  uint16_t discharge_bitset : 12; 
  uint8_t discharge_timeout : 4;  
} _PACKED LtcAfeConfigRegisterData;
static_assert(sizeof(LtcAfeConfigRegisterData) == 6, "LtcAfeConfigRegisterData must be 6 bytes");
 
typedef struct {
  uint8_t icom0 : 4;
  uint8_t d0 : 8;
  uint8_t fcom0 : 4;
 
  uint8_t icom1 : 4;
  uint8_t d1 : 8;
  uint8_t fcom1 : 4;
 
  uint8_t icom2 : 4;
  uint8_t d2 : 8;
  uint8_t fcom2 : 4;
} _PACKED LtcAfeCommRegisterData;
static_assert(sizeof(LtcAfeCommRegisterData) == 6, "LtcAfeCommRegisterData must be 6 bytes");
 
typedef struct {
  uint8_t wrcomm[LTC6811_CMD_SIZE];
  LtcAfeCommRegisterData reg;
  uint8_t pec;
} _PACKED LtcAfeWriteCommRegPacket;
 
typedef struct {
  uint8_t stcomm[LTC6811_CMD_SIZE];
  uint8_t clk[LTC6811_NUM_COMM_REG_BYTES];
} _PACKED LtcAfeSendCommRegPacket;
 
typedef struct {
  LtcAfeConfigRegisterData reg;
  uint16_t pec;
} _PACKED LtcAfeWriteDeviceConfigPacket;
 
typedef struct {
  uint8_t wrcfg[LTC6811_CMD_SIZE]; 
  LtcAfeWriteDeviceConfigPacket devices[LTC_AFE_MAX_CELLS_PER_DEVICE]; 
} _PACKED LtcAfeWriteConfigPacket;
#define SIZEOF_LTC_AFE_WRITE_CONFIG_PACKET(devices) (LTC6811_CMD_SIZE + (devices) * sizeof(LtcAfeWriteDeviceConfigPacket))
 
typedef union {
  uint16_t voltages[3]; 
  uint8_t values[6];    
} LtcAfeRegisterData;
static_assert(sizeof(LtcAfeRegisterData) == 6, "LtcAfeRegisterData must be 6 bytes");
 
typedef struct {
  LtcAfeRegisterData reg;
  uint16_t pec;
} _PACKED LtcAfeVoltageData;
static_assert(sizeof(LtcAfeVoltageData) == 8, "LtcAfeVoltageData must be 8 bytes");
 
typedef struct {
  LtcAfeRegisterData reg;
  uint16_t pec;
} _PACKED LtcAfeAuxData;
static_assert(sizeof(LtcAfeAuxData) == 8, "LtcAfeAuxData must be 8 bytes");
 
#define LTC6811_WRCFG_RESERVED (1 << 0)                                                           
#define LTC6811_RDCFG_RESERVED (1 << 1)                                                           
#define LTC6811_RDCVA_RESERVED (1 << 2)                                                           
#define LTC6811_RDCVB_RESERVED (1 << 2) | (1 << 1)                                                
#define LTC6811_RDCVC_RESERVED (1 << 3)                                                           
#define LTC6811_RDCVD_RESERVED (1 << 3) | (1 << 1)                                                
#define LTC6811_RDAUXA_RESERVED ((1 << 3) | (1 << 2))                                             
#define LTC6811_RDAUXB_RESERVED ((1 << 3) | (1 << 2)) | (1 << 1)                                  
#define LTC6811_RDSTATA_RESERVED (1 << 4)                                                         
#define LTC6811_RDSTATB_RESERVED (1 << 4) | (1 << 1)                                              
#define LTC6811_ADCV_RESERVED ((1 << 9) | (1 << 6) | (1 << 5))                                    
#define LTC6811_ADOW_RESERVED ((1 << 3) | (1 << 5) | (1 << 9))                                    
#define LTC6811_CVST_RESERVED ((1 << 0) | (1 << 1) | (1 << 2) | (1 << 9))                         
#define LTC6811_ADAX_RESERVED (1 << 10) | (1 << 6) | (1 << 5)                                     
#define LTC6811_CLRCELL_RESERVED (1 << 0) | (1 << 4) | (1 << 8) | (1 << 9) | (1 << 10)            
#define LTC6811_CLRAUX_RESERVED (1 << 1) | (1 << 4) | (1 << 8) | (1 << 9) | (1 << 10)             
#define LTC6811_CLRSTAT_RESERVED (1 << 0) | (1 << 1) | (1 << 4) | (1 << 8) | (1 << 9) | (1 << 10) 
#define LTC6811_PLADC_RESERVED (1 << 2) | (1 << 4) | (1 << 8) | (1 << 9) | (1 << 10)              
#define LTC6811_DIAGN_RESERVED (1 << 0) | (1 << 2) | (1 << 4) | (1 << 8) | (1 << 9) | (1 << 10)   
#define LTC6811_WRCOMM_RESERVED (1 << 0) | (1 << 5) | (1 << 8) | (1 << 9) | (1 << 10)             
#define LTC6811_RDCOMM_RESERVED (1 << 1) | (1 << 5) | (1 << 8) | (1 << 9) | (1 << 10)             
#define LTC6811_STCOMM_RESERVED (1 << 0) | (1 << 1) | (1 << 5) | (1 << 8) | (1 << 9) | (1 << 10)
#define LTC6811_WRPWM_RESERVED (1 << 5)            
#define LTC6811_RDPWM_RESERVED (1 << 5) | (1 << 2) 
#define LTC6811_GPIO1_PD_ON (0 << 3)
#define LTC6811_GPIO1_PD_OFF (1 << 3)
#define LTC6811_GPIO2_PD_ON (0 << 4)
#define LTC6811_GPIO2_PD_OFF (1 << 4)
#define LTC6811_GPIO3_PD_ON (0 << 5)
#define LTC6811_GPIO3_PD_OFF (1 << 5)
#define LTC6811_GPIO4_PD_ON (0 << 6)
#define LTC6811_GPIO4_PD_OFF (1 << 6)
#define LTC6811_GPIO5_PD_ON (0 << 7)
#define LTC6811_GPIO5_PD_OFF (1 << 7)
 
#define LTC6811_CNVT_CELL_ALL 0x00  
#define LTC6811_CNVT_CELL_1_7 0x01  
#define LTC6811_CNVT_CELL_2_8 0x02  
#define LTC6811_CNVT_CELL_3_9 0x03  
#define LTC6811_CNVT_CELL_4_10 0x04 
#define LTC6811_CNVT_CELL_5_11 0x05 
#define LTC6811_CNVT_CELL_6_12 0x06 
#define LTC6811_ADCV_DISCHARGE_NOT_PERMITTED (0 << 4)
#define LTC6811_ADCV_DISCHARGE_PERMITTED (1 << 4)
 
#define LTC6811_ADAX_GPIO1 0x01                    
#define LTC6811_ADAX_GPIO4 0x04                    
#define LTC6811_ADAX_MODE_FAST (0 << 8) | (1 << 7) 
#define LTC6811_ICOM_CSBM_LOW (1 << 3)                                     
#define LTC6811_ICOM_CSBM_FALL_EDGE (1 << 3) | (1 << 0)                    
#define LTC6811_ICOM_CSBM_HIGH (1 << 3) | (1 << 1)                         
#define LTC6811_ICOM_NO_TRANSMIT (1 << 3) | (1 << 2) | (1 << 1) | (1 << 0) 
#define LTC6811_FCOM_CSBM_LOW (0 << 0)             
#define LTC6811_FCOM_CSBM_HIGH (1 << 3) | (1 << 0) 
#define LTC6811_PWMC_DC_100 (0xF)