foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
crc.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file crc.h
44  * @author foxBMS Team
45  * @date 2022-02-22 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
48  * @ingroup DRIVERS
49  * @prefix CRC
50  *
51  * @brief crc module header
52  *
53  * @details Uses the system CRC hardware for data integrity calculation
54  */
55 
56 #ifndef FOXBMS__CRC_H_
57 #define FOXBMS__CRC_H_
58 
59 /*========== Includes =======================================================*/
60 #include "general.h"
61 
62 #include "HL_crc.h"
63 
64 /*========== Macros and Definitions =========================================*/
65 
66 /** High 32 bit part of the seed used for CRC calculation */
67 #define CRC_SEED_HIGH (0xBADC0DEDu)
68 /** Low 32 bit part of the seed used for CRC calculation */
69 #define CRC_SEED_LOW (0xDEADBEEFu)
70 /** Mask used to clear bits in config register to set CRC module to Data Capture Mode */
71 #define CRC_DATA_CAPTURE_MODE_CLEAR_MASK (0xFFFFFFFCu)
72 /** Mask used to set bits in config register to set CRC module to Full-CPU Mode */
73 #define CRC_FULL_CPU_MODE_SET_MASK (0x3u)
74 
75 /* Size in bits of a byte, used for shift operations */
76 #define CRC_BYTE_SIZE_IN_BITS (8u)
77 /* Size in bytes of a register, used for shift operations */
78 #define CRC_REGISTER_SIZE_IN_BYTES (4u)
79 /* Size in bits of a register, used for shift operations */
80 #define CRC_REGISTER_SIZE_IN_BITS (32u)
81 /* Literal used to reverse byte order */
82 #define CRC_REVERSE_BYTES_ORDER (3u)
83 
84 /** CRC signature register, low of high part to be used .
85  * The register is 64 bit wide but the data is read in
86  * 32 bit chunks. This indicates if the low or the high part
87  * has to be written.
88  */
89 typedef enum {
90  CRC_REGISTER_LOW, /* low part of register to be written */
91  CRC_REGISTER_HIGH, /* high part of register to be written */
93 
94 /*========== Extern Constant and Variable Declarations ======================*/
95 
96 /*========== Extern Function Prototypes =====================================*/
97 
98 /**
99  * @brief Computes CRC of data flow
100  * @details This function uses the hardware of the MCU.
101  * Data must be given in byte chunks.
102  * @param[in] pCrc uint64_t pointer to the calculated CRC
103  * @param[in] pData uint8_t pointer to the start of the data flow
104  * @param[in] lengthInBytes length in bytes of the data flow
105  * @returns #STD_OK if CRC hardware available, #STD_NOT_OK otherwise
106  */
107 extern STD_RETURN_TYPE_e CRC_CalculateCrc(uint64_t *pCrc, uint8_t *pData, uint32_t lengthInBytes);
108 
109 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
110 
111 #endif /* FOXBMS__CRC_H_ */
STD_RETURN_TYPE_e CRC_CalculateCrc(uint64_t *pCrc, uint8_t *pData, uint32_t lengthInBytes)
Computes CRC of data flow.
Definition: crc.c:71
CRC_REGISTER_SIDE_e
Definition: crc.h:89
@ CRC_REGISTER_HIGH
Definition: crc.h:91
@ CRC_REGISTER_LOW
Definition: crc.h:90
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
General macros and definitions for the whole platform.