foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
adi_ades183x_buffers.h File Reference

Header for the buffers used by the driver for the ADI analog front-end. More...

#include "adi_ades183x.h"
#include <stdint.h>
Include dependency graph for adi_ades183x_buffers.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Variables

uint8_t adi_configurationRegisterAgroup [BS_NR_OF_STRINGS][BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
 
uint8_t adi_configurationRegisterBgroup [BS_NR_OF_STRINGS][BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
 
uint8_t adi_readConfigurationRegisterAgroup [BS_NR_OF_STRINGS][BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
 
uint8_t adi_readConfigurationRegisterBgroup [BS_NR_OF_STRINGS][BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
 
uint16_t adi_command [ADI_COMMAND_DEFINITION_LENGTH]
 
uint8_t adi_dataTransmit [BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
 
uint8_t adi_dataReceive [BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
 
uint8_t adi_writeGlobal [ADI_MAX_REGISTER_SIZE_IN_BYTES]
 
uint8_t adi_clearFlagData [ADI_CLRFLAG_DATA_LENGTH]
 

Detailed Description

Header for the buffers used by the driver for the ADI analog front-end.

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
2022-12-07 (date of creation)
Updated
2023-10-12 (date of last update)
Version
v1.6.0
Prefix
ADI

The buffer are defined in a separate file and used throughout the driver. Their definition is included with this header.

Definition in file adi_ades183x_buffers.h.

Variable Documentation

◆ adi_clearFlagData

uint8_t adi_clearFlagData[ADI_CLRFLAG_DATA_LENGTH]
extern

Definition at line 90 of file adi_ades183x_buffers.c.

◆ adi_command

uint16_t adi_command[ADI_COMMAND_DEFINITION_LENGTH]
extern

Definition at line 83 of file adi_ades183x_buffers.c.

◆ adi_configurationRegisterAgroup

uint8_t adi_configurationRegisterAgroup[BS_NR_OF_STRINGS][BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
extern

Driver copy of the configuration stored in the AFE configuration registers

Definition at line 73 of file adi_ades183x_buffers.c.

◆ adi_configurationRegisterBgroup

uint8_t adi_configurationRegisterBgroup[BS_NR_OF_STRINGS][BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
extern

Definition at line 75 of file adi_ades183x_buffers.c.

◆ adi_dataReceive

Buffer used to read data from a register on the AFEs 6 bytes per module, which is the maximum size of a register in the AFE Same buffer used for 4 bytes wide registers

Definition at line 86 of file adi_ades183x_buffers.c.

◆ adi_dataTransmit

Buffer used to write data to a register on the AFEs 6 bytes per module, which is the maximum size of a register in the AFE Same buffer used for 4 bytes wide registers

Definition at line 85 of file adi_ades183x_buffers.c.

◆ adi_readConfigurationRegisterAgroup

uint8_t adi_readConfigurationRegisterAgroup[BS_NR_OF_STRINGS][BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
extern

Configuration read from the AFE configuration registers, used for comparison with written values

Definition at line 78 of file adi_ades183x_buffers.c.

◆ adi_readConfigurationRegisterBgroup

uint8_t adi_readConfigurationRegisterBgroup[BS_NR_OF_STRINGS][BS_NR_OF_MODULES_PER_STRING *ADI_MAX_REGISTER_SIZE_IN_BYTES]
extern

Definition at line 80 of file adi_ades183x_buffers.c.

◆ adi_writeGlobal

uint8_t adi_writeGlobal[ADI_MAX_REGISTER_SIZE_IN_BYTES]
extern

Buffer used to write the same data to a register for all the AFEs 6 bytes, which is the maximum size of a register in the AFE Same buffer used for 4 bytes wide registers Used in the function ADI_WriteRegisterGlobal(): there the content of adi_diagnosticWriteGlobal is copied everywhere in adi_dataTransmit

Definition at line 88 of file adi_ades183x_buffers.c.