Diff: LTC6811.h

Revision:

0:f06ed53310a3

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/LTC6811.h	Wed Feb 07 08:26:04 2018 +0000
@@ -0,0 +1,352 @@
+/*
+    LTC6811-1: Multicell Battery Monitor
+    LTC6811.h
+*/
+
+#ifndef LTC6811_H
+#define LTC6811_H
+
+#include "mbed.h"
+//#include <stdint.h>
+#include "LTC681x.h"
+
+#define CELL 1
+#define AUX 2
+#define STAT 3
+
+
+
+void LTC6811_init_reg_limits(uint8_t total_ic, cell_asic ic[]);
+
+
+/*! Starts the Mux Decoder diagnostic self test
+
+ Running this command will start the Mux Decoder Diagnostic Self Test
+ This test takes roughly 1mS to complete. The MUXFAIL bit will be updated,
+ the bit will be set to 1 for a failure and 0 if the test has been passed.
+
+*/
+void LTC6811_diagn();
+
+
+//! Sends the poll adc command
+//! @returns 1 byte read back after a pladc command. If the byte is not 0xFF ADC conversion has completed
+uint8_t LTC6811_pladc();
+
+
+//! This function will block operation until the ADC has finished it's conversion
+//! @returns the approximate time it took for the ADC function to complete.
+uint32_t LTC6811_pollAdc();
+
+/*! Starts cell voltage conversion
+*/
+void LTC6811_adcv(uint8_t MD, //!< ADC Conversion Mode
+                  uint8_t DCP, //!< Controls if Discharge is permitted during conversion
+                  uint8_t CH //!< Sets which Cell channels are converted
+                 );
+
+/*!  Starts cell voltage  and GPIO 1&2 conversion
+*/
+void LTC6811_adcvax(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t DCP //!< Controls if Discharge is permitted during conversion
+);
+
+
+/*!  Starts cell voltage self test conversion
+*/
+void LTC6811_cvst(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t ST //!< Self Test Mode
+);
+
+/*!  Starts cell voltage and SOC conversion
+*/
+void LTC6811_adcvsc(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t DCP //!< Controls if Discharge is permitted during conversion
+);
+/*!  Starts cell voltage overlap conversion
+*/
+void LTC6811_adol(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t DCP //!< Discharge permitted during conversion
+);
+
+/*!  Start an open wire Conversion
+*/
+void LTC6811_adow(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t PUP //!< Controls if Discharge is permitted during conversion
+);
+
+
+/*!  Start a GPIO and Vref2 Conversion
+*/
+void LTC6811_adax(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t CHG //!< Sets which GPIO channels are converted
+);
+
+/*!  Start an GPIO Redundancy test
+*/
+void LTC6811_adaxd(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t CHG //!< Sets which GPIO channels are converted
+);
+
+/*!  Start an Auxiliary Register Self Test Conversion
+*/
+void LTC6811_axst(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t ST //!< Sets if self test 1 or 2 is run
+);
+
+/*!  Start a Status ADC Conversion
+*/
+void LTC6811_adstat(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t CHST //!< Sets which Stat channels are converted
+);
+
+/*!   Start a Status register redundancy test Conversion
+*/
+void LTC6811_adstatd(
+  uint8_t MD, //!< ADC Mode
+  uint8_t CHST //!< Sets which Status channels are converted
+);
+
+
+/*!  Start a Status Register Self Test Conversion
+*/
+void LTC6811_statst(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t ST //!< Sets if self test 1 or 2 is run
+);
+
+/*!  Reads and parses the LTC6811 cell voltage registers.
+
+  @return int8_t, PEC Status.
+    0: No PEC error detected
+    -1: PEC error detected, retry read
+*/
+uint8_t LTC6811_rdcv(uint8_t reg, //!< controls which cell voltage register is read back.
+                     uint8_t total_ic, //!< the number of ICs in the daisy chain(-1 only)
+                     cell_asic ic[] //!< array of the parsed cell codes from lowest to highest.
+                    );
+
+
+
+/*!  Reads and parses the LTC6811 auxiliary registers.
+@return  int8_t, PEC Status
+  0: No PEC error detected
+ -1: PEC error detected, retry read
+*/
+int8_t LTC6811_rdaux(uint8_t reg,        //!< controls which GPIO voltage register is read back
+                     uint8_t nIC,        //!< the number of ICs in the daisy chain
+                     cell_asic ic[] //!< A two dimensional array of the parsed gpio voltage codes
+                    );
+
+/*!  Reads and parses the LTC6811 stat registers.
+
+@return  int8_t, PEC Status
+  0: No PEC error detected
+ -1: PEC error detected, retry read
+*/
+int8_t LTC6811_rdstat(uint8_t reg, //Determines which Stat  register is read back.
+                      uint8_t total_ic,//the number of ICs in the system
+                      cell_asic ic[]
+                     );
+
+/*!  Clears the LTC6811 cell voltage registers
+*/
+void LTC6811_clrcell();
+
+/*! Clears the LTC6811 Auxiliary registers
+*/
+void LTC6811_clraux();
+
+/*!  Clears the LTC6811 Stat registers
+*/
+void LTC6811_clrstat();
+
+/*!  Clears the LTC6811 Sctrl registers
+*/
+void LTC6811_clrsctrl();
+
+/*!  Write the LTC6811 configuration register
+*/
+void LTC6811_wrcfg(uint8_t nIC, //!< The number of ICs being written
+                   cell_asic ic[] //!< a two dimensional array of the configuration data that will be written
+                  );
+
+void LTC6811_wrcfgb(uint8_t nIC, //!< The number of ICs being written
+                    cell_asic ic[] //!< a two dimensional array of the configuration data that will be written
+                   );
+/*!  Reads configuration registers of a LTC6811 daisy chain
+@return int8_t, PEC Status.
+  0: Data read back has matching PEC
+   -1: Data read back has incorrect PEC
+*/
+int8_t LTC6811_rdcfg(uint8_t nIC, //!< number of ICs in the daisy chain
+                     cell_asic ic[] //!< a two dimensional array that the function stores the read configuration data
+                    );
+
+int8_t LTC6811_rdcfgb(uint8_t nIC, //!< number of ICs in the daisy chain
+                      cell_asic ic[] //!< a two dimensional array that the function stores the read configuration data
+                     );
+/*!  Write the LTC6811 PWM register
+*/
+void LTC6811_wrpwm(uint8_t nIC, //!< number of ICs in the daisy chain
+                   uint8_t pwmReg,
+                   cell_asic ic[]
+                  );
+
+/*!  Reads pwm registers of a LTC6811 daisy chain
+
+*/
+int8_t LTC6811_rdpwm(uint8_t nIC, //!< number of ICs in the daisy chain
+                     uint8_t pwmReg,
+                     cell_asic ic[] //!< a two dimensional array that the function stores the read pwm data
+                    );
+
+/*!  Write the LTC6811 Sctrl register
+*/
+void LTC6811_wrsctrl(uint8_t nIC, //!< number of ICs in the daisy chain
+                     uint8_t sctrl_reg,
+                     cell_asic ic[]
+                    );
+
+
+/*!  Reads sctrl registers of a LTC6811 daisy chain
+@return int8_t, PEC Status.
+  0: Data read back has matching PEC
+  -1: Data read back has incorrect PEC
+*/
+int8_t LTC6811_rdsctrl(uint8_t nIC, //!< number of ICs in the daisy chain
+                       uint8_t sctrl_reg,
+                       cell_asic ic[] //!< a two dimensional array that the function stores the read pwm data
+                      );
+
+
+/*!  Start Sctrl data communication
+This command will start the sctrl pulse communication over the spins
+*/
+void LTC6811_stsctrl();
+
+
+/*!  Write the LTC6811 COMM register
+*/
+void LTC6811_wrcomm(uint8_t total_ic, //!< Number of ICs in the daisy chain
+                    cell_asic ic[] //!< A two dimensional array of the comm data that will be written
+                   );
+
+/*!  Reads comm registers of a LTC6811 daisy chain
+@return int8_t, PEC Status.
+
+  0: Data read back has matching PEC
+
+  -1: Data read back has incorrect PEC
+
+*/
+int8_t LTC6811_rdcomm(uint8_t total_ic, //!< number of ICs in the daisy chain
+                      cell_asic ic[] //!< Two dimensional array that the function stores the read comm data.
+                     );
+
+/*!  issues a stcomm command and clocks data out of the COMM register */
+void LTC6811_stcomm();
+
+
+/*! @returns returns the register data pattern for a given ADC MD and Self test */
+uint16_t LTC6811_st_lookup(
+  uint8_t MD, //!< ADC Conversion Mode
+  uint8_t ST //!< Self test number
+);
+
+void LTC6811_set_discharge(int Cell,
+                           uint8_t total_ic,
+                           cell_asic ic[]);
+
+/*! Helper function that runs the ADC Self Tests*/
+int16_t LTC6811_run_cell_adc_st(uint8_t adc_reg,
+                                uint8_t total_ic,
+                                cell_asic ic[]);
+
+/*! Helper function that runs the ADC Digital Redudancy commands and checks output for errors*/
+int16_t LTC6811_run_adc_redundancy_st(uint8_t adc_mode,
+                                      uint8_t adc_reg,
+                                      uint8_t total_ic,
+                                      cell_asic ic[]);
+
+/*! Helper function that runs the datasheet open wire algorithm*/
+void LTC6811_run_openwire(uint8_t total_ic,
+                          cell_asic ic[]);
+
+void LTC6811_set_discharge(int Cell,
+                           uint8_t total_ic,
+                           cell_asic ic[]);
+
+/*! Helper Function that runs the ADC Overlap test*/
+uint16_t LTC6811_run_adc_overlap(uint8_t total_ic,
+                                 cell_asic ic[]);
+
+/*! Helper Function that counts overall PEC errors and register/IC PEC errors*/
+void LTC6811_check_pec(uint8_t total_ic,
+                       uint8_t reg,
+                       cell_asic ic[]);
+
+/*! Helper Function that resets the PEC error counters */
+void LTC6811_reset_crc_count(uint8_t total_ic,
+                             cell_asic ic[]);
+
+/*! Helper Function to initialize the CFGR data structures*/
+void LTC6811_init_cfg(uint8_t total_ic,
+                      cell_asic ic[]);
+
+/*! Helper function to set appropriate bits in CFGR register based on bit function*/
+void LTC6811_set_cfgr(uint8_t nIC,
+                      cell_asic ic[],
+                      bool refon,
+                      bool adcopt,
+                      bool gpio[5],
+                      bool dcc[12]);
+
+/*! Helper function to turn the refon bit HIGH or LOW*/
+void LTC6811_set_cfgr_refon(uint8_t nIC,
+                            cell_asic ic[],
+                            bool refon);
+
+/*! Helper function to turn the ADCOPT bit HIGH or LOW*/
+void LTC6811_set_cfgr_adcopt(uint8_t nIC,
+                             cell_asic ic[],
+                             bool adcopt);
+
+/*! Helper function to turn the GPIO bits HIGH or LOW*/
+void LTC6811_set_cfgr_gpio(uint8_t nIC,
+                           cell_asic ic[],
+                           bool gpio[]);
+
+/*! Helper function to turn the DCC bits HIGH or LOW*/
+void LTC6811_set_cfgr_dis(uint8_t nIC,
+                          cell_asic ic[],
+                          bool dcc[]);
+/*!  Helper function to set uv field in CFGRA register*/
+void LTC6811_set_cfgr_uv(uint8_t nIC,
+                         cell_asic ic[],
+                         uint16_t uv);
+
+/*!  Helper function to set ov field in CFGRA register*/
+void LTC6811_set_cfgr_ov(uint8_t nIC,
+                         cell_asic ic[],
+                         uint16_t ov);
+
+void LTC6811_init_max_min(uint8_t total_ic,
+                          cell_asic ic[],
+                          cell_asic ic_max[],
+                          cell_asic ic_min[]);
+
+void LTC6811_max_min(uint8_t total_ic, cell_asic ic_cells[],
+                     cell_asic ic_min[],
+                     cell_asic ic_max[],
+                     cell_asic ic_delta[]);
+#endif