The foxBMS secondary mcu API documentation
chksum.h File Reference

Header for the driver for the checksum calculation. More...

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

Go to the source code of this file.

Data Structures

struct  CHK_STATUS_s
 

Enumerations

enum  CHK_CHECKSUM_STATUS_e { CHK_CHECKSUM_FAILED = 0xFF, CHK_CHECKSUM_PASSED = 0x00 }
 

Functions

uint32_t CHK_crc32 (uint8_t *data, uint32_t len)
 CHK_crc32 provides crc32 algorithm. More...
 
STD_RETURN_TYPE_e CHK_Flashchecksum (const VER_ValidStruct_s *valid_struct)
 CHK_Flashchecksum provides validation for the currently used firmware. More...
 

Variables

CHK_STATUS_s chk_status
 

Detailed Description

Header for the driver for the checksum calculation.

BSD 3-Clause License 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
28.08.2015 (date of creation)
Module-prefix CHK

Enumeration Type Documentation

◆ CHK_CHECKSUM_STATUS_e

Enumerator
CHK_CHECKSUM_FAILED 
CHK_CHECKSUM_PASSED 

Function Documentation

◆ CHK_crc32()

uint32_t CHK_crc32 ( uint8_t *  data,
uint32_t  len 
)

CHK_crc32 provides crc32 algorithm.

This function provides crc32 checksum functionality with hardware support. It has been modified to match the common implementations used in zlib/WinZip/... RCC_CRC_CLK needs to be enabled.

Returns
(type: uint32_t)

◆ CHK_Flashchecksum()

STD_RETURN_TYPE_e CHK_Flashchecksum ( const VER_ValidStruct_s valid_struct)

CHK_Flashchecksum provides validation for the currently used firmware.

This function gets called during startup and validates the currently used firmware by doing a checksum over pre-defined memory areas and compares result with a pre-calculated checksum stored in the flashheader

Returns
(type: uint8_t)
Here is the call graph for this function:

Variable Documentation

◆ chk_status

CHK_STATUS_s chk_status