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

Headers for the PEC computations. More...

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

Go to the source code of this file.

Macros

#define ADI_PEC_BYTE_SIZE   (8u)
 
#define ADI_PEC_ONE_BYTE_MASK   (0xFFu)
 
#define ADI_PEC_PRECOMPUTED_TABLE_SIZE   (256u)
 
#define ADI_PEC15_POLYNOMIAL_SIZE   (15u)
 
#define ADI_PEC15_SEED   (0x10u)
 
#define ADI_PEC15_MASK   (0x7FFFu)
 
#define ADI_PEC10_POLYNOMIAL   (0x48Fu)
 
#define ADI_PEC10_POLYNOMIAL_SIZE   (10u)
 
#define ADI_PEC10_SEED   (0x10u)
 
#define ADI_PEC10_MASK   (0x3FFu)
 
#define ADI_PEC10_MSB_MASK   (0x200u)
 
#define ADI_PEC10_COMMAND_COUNTER_SIZE_IN_BITS   (6u)
 
#define ADI_PEC10_COMMAND_COUNTER_MASK   (0xFCu)
 

Functions

uint16_t ADI_Pec15 (uint8_t length, uint8_t *data)
 calculates the PEC15 More...
 
uint16_t ADI_Pec10 (uint8_t length, uint8_t *data, bool receive)
 calculates the PEC10 K More...
 

Detailed Description

Headers for the PEC computations.

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

The CRC polynomials used are defined in the data sheets of the ICs.

Definition in file adi_ades183x_pec.h.

Macro Definition Documentation

◆ ADI_PEC10_COMMAND_COUNTER_MASK

#define ADI_PEC10_COMMAND_COUNTER_MASK   (0xFCu)

Defines for the PEC computation

Definition at line 82 of file adi_ades183x_pec.h.

◆ ADI_PEC10_COMMAND_COUNTER_SIZE_IN_BITS

#define ADI_PEC10_COMMAND_COUNTER_SIZE_IN_BITS   (6u)

Defines for the PEC computation

Definition at line 81 of file adi_ades183x_pec.h.

◆ ADI_PEC10_MASK

#define ADI_PEC10_MASK   (0x3FFu)

Defines for the PEC computation

Definition at line 79 of file adi_ades183x_pec.h.

◆ ADI_PEC10_MSB_MASK

#define ADI_PEC10_MSB_MASK   (0x200u)

Defines for the PEC computation

Definition at line 80 of file adi_ades183x_pec.h.

◆ ADI_PEC10_POLYNOMIAL

#define ADI_PEC10_POLYNOMIAL   (0x48Fu)

Defines for the PEC computation

Definition at line 76 of file adi_ades183x_pec.h.

◆ ADI_PEC10_POLYNOMIAL_SIZE

#define ADI_PEC10_POLYNOMIAL_SIZE   (10u)

Defines for the PEC computation

Definition at line 77 of file adi_ades183x_pec.h.

◆ ADI_PEC10_SEED

#define ADI_PEC10_SEED   (0x10u)

Defines for the PEC computation

Definition at line 78 of file adi_ades183x_pec.h.

◆ ADI_PEC15_MASK

#define ADI_PEC15_MASK   (0x7FFFu)

Defines for the PEC computation

Definition at line 74 of file adi_ades183x_pec.h.

◆ ADI_PEC15_POLYNOMIAL_SIZE

#define ADI_PEC15_POLYNOMIAL_SIZE   (15u)

Defines for the PEC computation

Definition at line 72 of file adi_ades183x_pec.h.

◆ ADI_PEC15_SEED

#define ADI_PEC15_SEED   (0x10u)

Defines for the PEC computation

Definition at line 73 of file adi_ades183x_pec.h.

◆ ADI_PEC_BYTE_SIZE

#define ADI_PEC_BYTE_SIZE   (8u)

Defines for the PEC computation

Definition at line 68 of file adi_ades183x_pec.h.

◆ ADI_PEC_ONE_BYTE_MASK

#define ADI_PEC_ONE_BYTE_MASK   (0xFFu)

Defines for the PEC computation

Definition at line 69 of file adi_ades183x_pec.h.

◆ ADI_PEC_PRECOMPUTED_TABLE_SIZE

#define ADI_PEC_PRECOMPUTED_TABLE_SIZE   (256u)

Defines for the PEC computation

Definition at line 70 of file adi_ades183x_pec.h.

Function Documentation

◆ ADI_Pec10()

uint16_t ADI_Pec10 ( uint8_t  length,
uint8_t *  data,
bool  receive 
)

calculates the PEC10 K

Parameters
lengthNumber of bytes that will be used to calculate a PEC
dataArray of data that will be used to calculate a PEC
receivetrue if data was received, false if data is to be sent
Returns
PEC10

Definition at line 120 of file adi_ades183x_pec.c.

◆ ADI_Pec15()

uint16_t ADI_Pec15 ( uint8_t  length,
uint8_t *  data 
)

calculates the PEC15

Parameters
lengthNumber of bytes that will be used to calculate a PEC
dataArray of data that will be used to calculate a PEC
Returns
PEC15, shifted one bit to the left

Definition at line 78 of file adi_ades183x_pec.c.