foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
ltc_6813-1_cfg.h File Reference

Header for the configuration for the LTC 6804-1 6811-1, 6812-1, and 6813-1 monitoring IC. More...

#include "ltc_cfg.h"
#include "ltc_defs.h"
#include "battery_system_cfg.h"
#include "ltc_afe_dma.h"
#include "spi.h"
Include dependency graph for ltc_6813-1_cfg.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define SLAVE_BOARD_VERSION   (2)
 
#define LTC_PORTEXPANDER_VERSION   (1u)
 
#define LTC_PORTEXPANDER_ADR_TI   (0u)
 
#define LTC_DISCARD_PEC   (false)
 
#define LTC_GOTO_MUX_CHECK   (true)
 
#define LTC_DISCARD_MUX_CHECK   (false)
 
#define LTC_N_MUX_PER_LTC   (3u)
 
#define LTC_N_MUX_CHANNELS_PER_MUX   (8u)
 
#define LTC_NUMBER_OF_MUX_MEASUREMENTS_PER_CYCLE   (8u)
 
#define LTC_N_MUX_CHANNELS_PER_LTC   (LTC_N_MUX_PER_LTC * LTC_N_MUX_CHANNELS_PER_MUX)
 
#define LTC_NUMBER_OF_LTC_PER_MODULE   (1u)
 
#define LTC_ADOW_THRESHOLD   (-400)
 
#define LTC_VOLTAGE_MEASUREMENT_MODE   (LTC_ADCMODE_NORMAL_DCP0)
 
#define LTC_GPIO_MEASUREMENT_MODE   (LTC_ADCMODE_NORMAL_DCP0)
 
#define LTC_OW_MEASUREMENT_MODE   (LTC_ADCMODE_NORMAL_DCP0)
 
#define LTC_TRANSMISSION_TIMEOUT   (10)
 
#define LTC_TWAKE_US   (300)
 
#define LTC_TREADY_US   (10)
 
#define LTC_TIDLE_US   (6700)
 
#define LTC_SPI_WAKEUP_WAIT_TIME_US   (30U)
 
#define LTC_STATEMACH_SHORTTIME   (1)
 
#define LTC_STATEMACH_DAISY_CHAIN_FIRST_INITIALIZATION_TIME   ((LTC_TWAKE_US * LTC_N_LTC) / 1000)
 
#define LTC_STATEMACH_DAISY_CHAIN_SECOND_INITIALIZATION_TIME   ((LTC_TREADY_US * LTC_N_LTC) / 1000)
 
#define LTC_STATEMACH_MEAS_ALL_FAST_TCYCLE   (2)
 
#define LTC_STATEMACH_MEAS_ALL_NORMAL_TCYCLE   (3)
 
#define LTC_STATEMACH_MEAS_ALL_FILTERED_TCYCLE   (202)
 
#define LTC_STATEMACH_MEAS_SINGLE_FAST_TCYCLE   (1)
 
#define LTC_STATEMACH_MEAS_SINGLE_NORMAL_TCYCLE   (1)
 
#define LTC_STATEMACH_MEAS_SINGLE_FILTERED_TCYCLE   (35)
 
#define LTC_STATEMACH_SEQERRTTIME   (5)
 
#define LTC_STATEMACH_PECERRTIME   (1)
 
#define LTC_TRANSMIT_PECERRLIMIT   (10)
 
#define LTC_TRANSMIT_SPIERRLIMIT   (3)
 
#define LTC_READCOM   (0)
 
#define LTC_STANDBY_PERIODIC_OPEN_WIRE_CHECK   (false)
 
#define LTC_STANDBY_OPEN_WIRE_PERIOD_ms   (600000)
 
#define LTC_NORMAL_PERIODIC_OPEN_WIRE_CHECK   (false)
 
#define LTC_NORMAL_OPEN_WIRE_PERIOD_ms   (600000)
 
#define LTC_CHARGE_PERIODIC_OPEN_WIRE_CHECK   (false)
 
#define LTC_CHARGE_OPEN_WIRE_PERIOD_ms   (600000)
 
#define LTC_ERROR_OPEN_WIRE_PERIOD_ms   (30000)
 
#define LTC_NMBR_REQ_ADOW_COMMANDS   (2)
 
#define LTC_SPI_HANDLE   &spi_devices[0]
 
#define LTC_SPI_INSTANCE   *LTC_SPI_HANDLE.Instance
 
#define LTC_SPI_PRESCALER   *LTC_SPI_HANDLE.Init.BaudRatePrescaler
 
#define LTC_TransmitWakeUp(spi_ltcInterface)   SPI_TransmitDummyByte(spi_ltcInterface, LTC_SPI_WAKEUP_WAIT_TIME_US)
 
#define LTC_TransmitI2cCommand(spi_ltcInterface, txbuf)    SPI_TransmitDataWithDummy(spi_ltcInterface, LTC_SPI_WAKEUP_WAIT_TIME_US, txbuf, 4 + 9)
 
#define LTC_TransmitCommand(spi_ltcInterface, command)    SPI_TransmitDataWithDummy(spi_ltcInterface, LTC_SPI_WAKEUP_WAIT_TIME_US, command, 4)
 
#define LTC_TransmitReceiveData(spi_ltcInterface, txbuf, rxbuf, length)    SPI_TransmitReceiveDataWithDummyDma(spi_ltcInterface, LTC_SPI_WAKEUP_WAIT_TIME_US, txbuf, rxbuf, length)
 

Functions

int16_t LTC_Convert_MuxVoltages_to_Temperatures (uint16_t adcVoltage_mV)
 converts a raw voltage from multiplexer to a temperature value in deci °C. More...
 

Variables

LTC_MUX_SEQUENCE_s ltc_mux_seq
 
const uint8_t ltc_muxsensortemperatur_cfg [BS_NR_OF_TEMP_SENSORS_PER_MODULE]
 
const uint8_t ltc_voltage_input_used [BS_MAX_SUPPORTED_CELLS]
 

Detailed Description

Header for the configuration for the LTC 6804-1 6811-1, 6812-1, and 6813-1 monitoring IC.

SPDX-License-Identifier: BSD-3-Clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2015-02-18 (date of creation)
Updated
2021-03-24 (date of last update)
Prefix
LTC

Definition in file ltc_6813-1_cfg.h.

Macro Definition Documentation

◆ LTC_ADOW_THRESHOLD

#define LTC_ADOW_THRESHOLD   (-400)

Open-wire detection threshold

Definition at line 117 of file ltc_6813-1_cfg.h.

◆ LTC_CHARGE_OPEN_WIRE_PERIOD_ms

#define LTC_CHARGE_OPEN_WIRE_PERIOD_ms   (600000)

Periodic open-wire check time in CHARGE state in ms

Definition at line 268 of file ltc_6813-1_cfg.h.

◆ LTC_CHARGE_PERIODIC_OPEN_WIRE_CHECK

#define LTC_CHARGE_PERIODIC_OPEN_WIRE_CHECK   (false)

open-wire check in charge mode (set to true or false)

Definition at line 265 of file ltc_6813-1_cfg.h.

◆ LTC_DISCARD_MUX_CHECK

#define LTC_DISCARD_MUX_CHECK   (false)

Definition at line 99 of file ltc_6813-1_cfg.h.

◆ LTC_DISCARD_PEC

#define LTC_DISCARD_PEC   (false)

Controls if PEC should be discarded (true) or not (false)

Definition at line 93 of file ltc_6813-1_cfg.h.

◆ LTC_ERROR_OPEN_WIRE_PERIOD_ms

#define LTC_ERROR_OPEN_WIRE_PERIOD_ms   (30000)

Periodic open-wire check time in ERROR state in ms

Definition at line 271 of file ltc_6813-1_cfg.h.

◆ LTC_GOTO_MUX_CHECK

#define LTC_GOTO_MUX_CHECK   (true)

Definition at line 96 of file ltc_6813-1_cfg.h.

◆ LTC_GPIO_MEASUREMENT_MODE

#define LTC_GPIO_MEASUREMENT_MODE   (LTC_ADCMODE_NORMAL_DCP0)

Measurement modus for GPIOs, possible values:

  • LTC_ADCMODE_NORMAL_DCP0
  • LTC_ADCMODE_FILTERED_DCP0
  • LTC_ADCMODE_FAST_DCP0

Definition at line 133 of file ltc_6813-1_cfg.h.

◆ LTC_N_MUX_CHANNELS_PER_LTC

#define LTC_N_MUX_CHANNELS_PER_LTC   (LTC_N_MUX_PER_LTC * LTC_N_MUX_CHANNELS_PER_MUX)

Number of multiplexed channels per LTC-IC

Definition at line 111 of file ltc_6813-1_cfg.h.

◆ LTC_N_MUX_CHANNELS_PER_MUX

#define LTC_N_MUX_CHANNELS_PER_MUX   (8u)

Number of channels per multiplexer

Definition at line 105 of file ltc_6813-1_cfg.h.

◆ LTC_N_MUX_PER_LTC

#define LTC_N_MUX_PER_LTC   (3u)

Number of multiplexer used per LTC-IC

Definition at line 102 of file ltc_6813-1_cfg.h.

◆ LTC_NMBR_REQ_ADOW_COMMANDS

#define LTC_NMBR_REQ_ADOW_COMMANDS   (2)

Number of required ADOW commands because of external C-Pin capacitance and the respective duration to perform an open wire check for 14 modules with 12 cells each. During this time no cell voltages and temperatures are measured! +-------------—+-----------—+------------—+-------—+-------—+ | External C pin | Normal mode | Filtered mode | Duration | Duration | | capacitance | | | normal | filtered | | ------------—+-----------—+------------—+-------—+-------—+ | <= 10nF | 2 | 2 | 32ms | 828ms | | 100nF | 10 | 2 | 112ms | 828ms | | 1uF | 100 | 2 | 1012ms | 828ms | | C | 1.5+(C/10nF) | 2 | | | +-------------—+-----------—+------------—+-------—+-------—+

Definition at line 287 of file ltc_6813-1_cfg.h.

◆ LTC_NORMAL_OPEN_WIRE_PERIOD_ms

#define LTC_NORMAL_OPEN_WIRE_PERIOD_ms   (600000)

Periodic open-wire check time in NORMAL state in ms

Definition at line 262 of file ltc_6813-1_cfg.h.

◆ LTC_NORMAL_PERIODIC_OPEN_WIRE_CHECK

#define LTC_NORMAL_PERIODIC_OPEN_WIRE_CHECK   (false)

open-wire check in normal mode (set to true or false)

Definition at line 259 of file ltc_6813-1_cfg.h.

◆ LTC_NUMBER_OF_LTC_PER_MODULE

#define LTC_NUMBER_OF_LTC_PER_MODULE   (1u)

Number of LTC-ICs per battery module

Definition at line 114 of file ltc_6813-1_cfg.h.

◆ LTC_NUMBER_OF_MUX_MEASUREMENTS_PER_CYCLE

#define LTC_NUMBER_OF_MUX_MEASUREMENTS_PER_CYCLE   (8u)

Number of multiplexer measurements per LTC cycle

Definition at line 108 of file ltc_6813-1_cfg.h.

◆ LTC_OW_MEASUREMENT_MODE

#define LTC_OW_MEASUREMENT_MODE   (LTC_ADCMODE_NORMAL_DCP0)

Measurement modus for Open-wire check, possible values:

  • LTC_ADCMODE_NORMAL_DCP0
  • LTC_ADCMODE_FILTERED_DCP0

Definition at line 140 of file ltc_6813-1_cfg.h.

◆ LTC_PORTEXPANDER_ADR_TI

#define LTC_PORTEXPANDER_ADR_TI   (0u)

Address of TI port expander (0 or 1)

Definition at line 90 of file ltc_6813-1_cfg.h.

◆ LTC_PORTEXPANDER_VERSION

#define LTC_PORTEXPANDER_VERSION   (1u)

If set to 0 LTC driver is configured to use PCA8574 port expander If set to 1 LTC driver is configured to use TCA6408A port expander

Definition at line 87 of file ltc_6813-1_cfg.h.

◆ LTC_READCOM

#define LTC_READCOM   (0)

If set to 1, check if multiplexers acknowledged transmission

Definition at line 243 of file ltc_6813-1_cfg.h.

◆ LTC_SPI_HANDLE

#define LTC_SPI_HANDLE   &spi_devices[0]

SPI1 is used for communication with LTC

Definition at line 152 of file ltc_6813-1_cfg.h.

◆ LTC_SPI_INSTANCE

#define LTC_SPI_INSTANCE   *LTC_SPI_HANDLE.Instance

SPI1 is used for communication with LTC

Definition at line 153 of file ltc_6813-1_cfg.h.

◆ LTC_SPI_PRESCALER

#define LTC_SPI_PRESCALER   *LTC_SPI_HANDLE.Init.BaudRatePrescaler

SPI1 is used for communication with LTC

Definition at line 154 of file ltc_6813-1_cfg.h.

◆ LTC_SPI_WAKEUP_WAIT_TIME_US

#define LTC_SPI_WAKEUP_WAIT_TIME_US   (30U)

LTC SPI wakeup time

Definition at line 165 of file ltc_6813-1_cfg.h.

◆ LTC_STANDBY_OPEN_WIRE_PERIOD_ms

#define LTC_STANDBY_OPEN_WIRE_PERIOD_ms   (600000)

Periodic open-wire check time in STANDBY state in ms

Definition at line 256 of file ltc_6813-1_cfg.h.

◆ LTC_STANDBY_PERIODIC_OPEN_WIRE_CHECK

#define LTC_STANDBY_PERIODIC_OPEN_WIRE_CHECK   (false)

----------------— OPEN WIRE CHECK ---------------------— If open-wire check is performed cell voltages and temperatures are not updated and thus old values can be transmitted on the CAN bus. Check time is dependent on module configuration and external capacitance. Activate open-wire check with care! See table below for various measured open-wire check durations! (set to TRUE or FALSE)

Definition at line 253 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_DAISY_CHAIN_FIRST_INITIALIZATION_TIME

#define LTC_STATEMACH_DAISY_CHAIN_FIRST_INITIALIZATION_TIME   ((LTC_TWAKE_US * LTC_N_LTC) / 1000)

time for the first initialization of the daisy chain see LTC6804 datasheet page 41

Definition at line 174 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_DAISY_CHAIN_SECOND_INITIALIZATION_TIME

#define LTC_STATEMACH_DAISY_CHAIN_SECOND_INITIALIZATION_TIME   ((LTC_TREADY_US * LTC_N_LTC) / 1000)

time for the second initialization of the daisy chain see LTC6804 datasheet page 41

Definition at line 179 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_MEAS_ALL_FAST_TCYCLE

#define LTC_STATEMACH_MEAS_ALL_FAST_TCYCLE   (2)

~1.1ms Measurement+Calibration Cycle Time When Starting from the REFUP State in Fast Mode unit: ms

Definition at line 189 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_MEAS_ALL_FILTERED_TCYCLE

#define LTC_STATEMACH_MEAS_ALL_FILTERED_TCYCLE   (202)

~201ms Measurement+Calibration Cycle Time When Starting from the REFUP State in Filtered Mode unit: ms

Definition at line 201 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_MEAS_ALL_NORMAL_TCYCLE

#define LTC_STATEMACH_MEAS_ALL_NORMAL_TCYCLE   (3)

~2.3ms Measurement+Calibration Cycle Time When Starting from the REFUP State in Normal Mode unit: ms

Definition at line 195 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_MEAS_SINGLE_FAST_TCYCLE

#define LTC_STATEMACH_MEAS_SINGLE_FAST_TCYCLE   (1)

~0.201ms Measurement+Calibration Cycle Time When Starting from the REFUP State in Fast Mode unit: ms

Definition at line 211 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_MEAS_SINGLE_FILTERED_TCYCLE

#define LTC_STATEMACH_MEAS_SINGLE_FILTERED_TCYCLE   (35)

~34 ms Measurement+Calibration Cycle Time When Starting from the REFUP State in Filtered Mode unit: ms

Definition at line 223 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_MEAS_SINGLE_NORMAL_TCYCLE

#define LTC_STATEMACH_MEAS_SINGLE_NORMAL_TCYCLE   (1)

~0.405ms Measurement+Calibration Cycle Time When Starting from the REFUP State in Normal Mode unit: ms

Definition at line 217 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_PECERRTIME

#define LTC_STATEMACH_PECERRTIME   (1)

LTC statemachine CRC-transmission error timing in ms

Definition at line 228 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_SEQERRTTIME

#define LTC_STATEMACH_SEQERRTTIME   (5)

LTC statemachine sequence error timing in ms

Definition at line 226 of file ltc_6813-1_cfg.h.

◆ LTC_STATEMACH_SHORTTIME

#define LTC_STATEMACH_SHORTTIME   (1)

LTC statemachine short time definition in ms

Definition at line 168 of file ltc_6813-1_cfg.h.

◆ LTC_TIDLE_US

#define LTC_TIDLE_US   (6700)

start definition of LTC timings; Tidle (see LTC datasheet)

Definition at line 162 of file ltc_6813-1_cfg.h.

◆ LTC_TRANSMISSION_TIMEOUT

#define LTC_TRANSMISSION_TIMEOUT   (10)

Timeout in milliseconds added to the transmission time for interrupt-based SPI transmission.

Definition at line 146 of file ltc_6813-1_cfg.h.

◆ LTC_TRANSMIT_PECERRLIMIT

#define LTC_TRANSMIT_PECERRLIMIT   (10)

Maximum number of re-tries in case of CRC error during the communication with daisy chain before going into error state

Definition at line 234 of file ltc_6813-1_cfg.h.

◆ LTC_TRANSMIT_SPIERRLIMIT

#define LTC_TRANSMIT_SPIERRLIMIT   (3)

Maximum number of re-tries in case of SPI error during the communication with daisy chain before going into error state

Definition at line 240 of file ltc_6813-1_cfg.h.

◆ LTC_TransmitCommand

#define LTC_TransmitCommand (   spi_ltcInterface,
  command 
)     SPI_TransmitDataWithDummy(spi_ltcInterface, LTC_SPI_WAKEUP_WAIT_TIME_US, command, 4)

Transmit functions

Definition at line 296 of file ltc_6813-1_cfg.h.

◆ LTC_TransmitI2cCommand

#define LTC_TransmitI2cCommand (   spi_ltcInterface,
  txbuf 
)     SPI_TransmitDataWithDummy(spi_ltcInterface, LTC_SPI_WAKEUP_WAIT_TIME_US, txbuf, 4 + 9)

Transmit functions

Definition at line 294 of file ltc_6813-1_cfg.h.

◆ LTC_TransmitReceiveData

#define LTC_TransmitReceiveData (   spi_ltcInterface,
  txbuf,
  rxbuf,
  length 
)     SPI_TransmitReceiveDataWithDummyDma(spi_ltcInterface, LTC_SPI_WAKEUP_WAIT_TIME_US, txbuf, rxbuf, length)

Transmit functions

Definition at line 298 of file ltc_6813-1_cfg.h.

◆ LTC_TransmitWakeUp

Transmit functions

Definition at line 293 of file ltc_6813-1_cfg.h.

◆ LTC_TREADY_US

#define LTC_TREADY_US   (10)

start definition of LTC timings; Tready (see LTC datasheet)

Definition at line 160 of file ltc_6813-1_cfg.h.

◆ LTC_TWAKE_US

#define LTC_TWAKE_US   (300)

start definition of LTC timings; Twake (see LTC datasheet)

Definition at line 158 of file ltc_6813-1_cfg.h.

◆ LTC_VOLTAGE_MEASUREMENT_MODE

#define LTC_VOLTAGE_MEASUREMENT_MODE   (LTC_ADCMODE_NORMAL_DCP0)

Measurement modus for voltages, possible values:

  • LTC_ADCMODE_NORMAL_DCP0
  • LTC_ADCMODE_FILTERED_DCP0
  • LTC_ADCMODE_FAST_DCP0

Definition at line 125 of file ltc_6813-1_cfg.h.

◆ SLAVE_BOARD_VERSION

#define SLAVE_BOARD_VERSION   (2)

If set to 1 LTC driver is configured to use foxBMS slave boards version 1.x If set to 2 LTC driver is configured to use foxBMS slave boards version 2.x

Definition at line 75 of file ltc_6813-1_cfg.h.

Function Documentation

◆ LTC_Convert_MuxVoltages_to_Temperatures()

int16_t LTC_Convert_MuxVoltages_to_Temperatures ( uint16_t  adcVoltage_mV)

converts a raw voltage from multiplexer to a temperature value in deci °C.

The temperatures are read from NTC elements via voltage dividers. This function implements the look-up table between voltage and temperature, taking into account the NTC characteristics and the voltage divider.

Parameters
adcVoltage_mVvoltage read from the multiplexer in mV
Returns
temperature value in deci °C

Definition at line 225 of file ltc_6813-1_cfg.c.

Variable Documentation

◆ ltc_mux_seq

LTC_MUX_SEQUENCE_s ltc_mux_seq
extern

Definition of the multiplexer measurement sequence

Definition at line 179 of file ltc_6813-1_cfg.c.

◆ ltc_muxsensortemperatur_cfg

const uint8_t ltc_muxsensortemperatur_cfg[BS_NR_OF_TEMP_SENSORS_PER_MODULE]
extern

On the foxBMS slave board there are 6 multiplexer inputs dedicated to temperature sensors by default. Lookup table between temperature sensors and battery cells

Definition at line 183 of file ltc_6813-1_cfg.c.

◆ ltc_voltage_input_used

const uint8_t ltc_voltage_input_used[BS_MAX_SUPPORTED_CELLS]
extern

Lookup table to indicate which voltage inputs are used

Definition at line 63 of file ltc_6806_cfg.c.