foxBMS
1.5.0
The foxBMS Battery Management System API Documentation

CRC8 calculation for Maxim Integrated Monitoring devices. More...
#include "general.h"
#include "mxm_crc8.h"
#include "fassert.h"
#include "fstd_types.h"
#include <stdint.h>
Go to the source code of this file.
Functions  
static uint8_t  MXM_CRC8WithInitValue (uint16_t *pData, int32_t lenData, uint8_t crcInit) 
Compute CRC8 (0xA6) with initial value. More...  
uint8_t  MXM_CRC8 (uint16_t *pData, int32_t lenData) 
Compute CRC8 with initial value set to 0x00. More...  
STD_RETURN_TYPE_e GEN_MUST_CHECK_RETURN  MXM_CRC8SelfTest (void) 
Test the CRC8algorithm with a known pattern. More...  
CRC8 calculation for Maxim Integrated Monitoring devices.
SPDXLicenseIdentifier: BSD3Clause
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
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 module supports the calculation of a CRC8 based on the polynomial described in the Maxim data sheets. The polynomial is 0xA6.
Definition in file mxm_crc8.c.
uint8_t MXM_CRC8  (  uint16_t *  pData, 
int32_t  lenData  
) 
Compute CRC8 with initial value set to 0x00.
Computes the CRC8 for the given data with the given length with the polynomial 0xA6. This function calls MXM_CRC8WithInitValue() with CRC set to 0x00. The result should be 0x00 if you include the CRC into the datastream.
[in]  pData  arraypointer with data to be cyclic redundancy checked 
[in]  lenData  length of array 
Definition at line 140 of file mxm_crc8.c.
STD_RETURN_TYPE_e GEN_MUST_CHECK_RETURN MXM_CRC8SelfTest  (  void  ) 
Test the CRC8algorithm with a known pattern.
Tests the CRC8algorithm with known patterns and asserts that the implementation matches the required algorithm.
Definition at line 147 of file mxm_crc8.c.

static 
Compute CRC8 (0xA6) with initial value.
Computes the CRC8 for the given data with the polynomial 0xA6.
[in]  pData  arraypointer with data to be cyclic redundancy checked 
[in]  lenData  length of array 
[in]  crcInit  initial CRCvalue 
Precomputed CRC8table for polynomial 0xA6
This array contains the precomputed results for the lookuptablebased computation of a CRC8 with polynomial 0xA6. The polynomialnumber represents the coefficients of the polynomial like this: 8 7 6 5 4 3 2 1 0 1 0 1 0 0 1 1 0 1 > 14D
This polynomial can also be called 0x14D according to the notation (0xA6 << 1).
Definition at line 87 of file mxm_crc8.c.