foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
crc.h File Reference

crc module header More...

#include "general.h"
#include "HL_crc.h"
Include dependency graph for crc.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define CRC_SEED_HIGH   (0xBADC0DEDu)
 
#define CRC_SEED_LOW   (0xDEADBEEFu)
 
#define CRC_DATA_CAPTURE_MODE_CLEAR_MASK   (0xFFFFFFFCu)
 
#define CRC_FULL_CPU_MODE_SET_MASK   (0x3u)
 
#define CRC_BYTE_SIZE_IN_BITS   (8u)
 
#define CRC_REGISTER_SIZE_IN_BYTES   (4u)
 
#define CRC_REGISTER_SIZE_IN_BITS   (32u)
 
#define CRC_REVERSE_BYTES_ORDER   (3u)
 

Enumerations

enum  CRC_REGISTER_SIDE_e { CRC_REGISTER_LOW , CRC_REGISTER_HIGH }
 

Functions

STD_RETURN_TYPE_e CRC_CalculateCrc (uint64_t *pCrc, uint8_t *pData, uint32_t lengthInBytes)
 Computes CRC of data flow. More...
 

Detailed Description

crc module header

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-02-22 (date of creation)
Updated
2022-10-27 (date of last update)
Version
v1.4.1
Prefix
CRC

Uses the system CRC hardware for data integrity calculation

Definition in file crc.h.

Macro Definition Documentation

◆ CRC_BYTE_SIZE_IN_BITS

#define CRC_BYTE_SIZE_IN_BITS   (8u)

Definition at line 76 of file crc.h.

◆ CRC_DATA_CAPTURE_MODE_CLEAR_MASK

#define CRC_DATA_CAPTURE_MODE_CLEAR_MASK   (0xFFFFFFFCu)

Mask used to clear bits in config register to set CRC module to Data Capture Mode

Definition at line 71 of file crc.h.

◆ CRC_FULL_CPU_MODE_SET_MASK

#define CRC_FULL_CPU_MODE_SET_MASK   (0x3u)

Mask used to set bits in config register to set CRC module to Full-CPU Mode

Definition at line 73 of file crc.h.

◆ CRC_REGISTER_SIZE_IN_BITS

#define CRC_REGISTER_SIZE_IN_BITS   (32u)

Definition at line 80 of file crc.h.

◆ CRC_REGISTER_SIZE_IN_BYTES

#define CRC_REGISTER_SIZE_IN_BYTES   (4u)

Definition at line 78 of file crc.h.

◆ CRC_REVERSE_BYTES_ORDER

#define CRC_REVERSE_BYTES_ORDER   (3u)

Definition at line 82 of file crc.h.

◆ CRC_SEED_HIGH

#define CRC_SEED_HIGH   (0xBADC0DEDu)

High 32 bit part of the seed used for CRC calculation

Definition at line 67 of file crc.h.

◆ CRC_SEED_LOW

#define CRC_SEED_LOW   (0xDEADBEEFu)

Low 32 bit part of the seed used for CRC calculation

Definition at line 69 of file crc.h.

Enumeration Type Documentation

◆ CRC_REGISTER_SIDE_e

CRC signature register, low of high part to be used . The register is 64 bit wide but the data is read in 32 bit chunks. This indicates if the low or the high part has to be written.

Enumerator
CRC_REGISTER_LOW 
CRC_REGISTER_HIGH 

Definition at line 89 of file crc.h.

Function Documentation

◆ CRC_CalculateCrc()

STD_RETURN_TYPE_e CRC_CalculateCrc ( uint64_t *  pCrc,
uint8_t *  pData,
uint32_t  lengthInBytes 
)

Computes CRC of data flow.

This function uses the hardware of the MCU. Data must be given in byte chunks.

Parameters
[in]pCrcuint64_t pointer to the calculated CRC
[in]pDatauint8_t pointer to the start of the data flow
[in]lengthInByteslength in bytes of the data flow
Returns
STD_OK if CRC hardware available, STD_NOT_OK otherwise

Definition at line 71 of file crc.c.