foxBMS  1.1.0
The foxBMS Battery Management System API Documentation
mxm_crc8.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, 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 mxm_crc8.h
44  * @author foxBMS Team
45  * @date 2019-02-05 (date of creation)
46  * @updated 2020-04-27 (date of last update)
47  * @ingroup DRIVERS
48  * @prefix MXM
49  *
50  * @brief Headers for the CRC8 calculation for Maxim Integrated
51  * Monitoring devices
52  *
53  * @details This module supports the calculation of a CRC8 based on the
54  * polynomial described in the Maxim datasheets.
55  * The polynomial is 0xA6.
56  *
57  */
58 
59 #ifndef FOXBMS__MXM_CRC8_H_
60 #define FOXBMS__MXM_CRC8_H_
61 
62 /*========== Includes =======================================================*/
63 #include "general.h"
64 
65 /*========== Macros and Definitions =========================================*/
66 
67 /*========== Extern Constant and Variable Declarations ======================*/
68 
69 /*========== Extern Function Prototypes =====================================*/
70 
71 /**
72  * @brief Compute CRC8 (0xA6) with initial value.
73  * @details Computes the CRC8 for the given data with the polynomial 0xA6.
74  * @param[in] pData array-pointer with data to be cyclic redundancy checked
75  * @param[in] lenData length of array
76  * @param[in] crcInit initial CRC-value
77  * @return uint8_t containing the computed CRC
78  */
79 extern uint8_t MXM_CRC8WithInitValue(uint16_t *pData, int32_t lenData, uint8_t crcInit);
80 
81 /**
82  * @brief Compute CRC8 with initial value set to 0x00.
83  * @details Computes the CRC8 for the given data with the given length
84  * with the polynomial 0xA6. This function calls
85  * #MXM_CRC8WithInitValue() with CRC set to 0x00.
86  * The result should be 0x00 if you include the CRC into
87  * the datastream.
88  * @param[in] pData array-pointer with data to be cyclic redundancy checked
89  * @param[in] lenData length of array
90  * @return uint8_t containing the computed CRC
91  */
92 extern uint8_t MXM_CRC8(uint16_t *pData, int32_t lenData);
93 
94 /**
95  * @brief Test the CRC8-algorithm with a known pattern.
96  * @details Tests the CRC8-algorithm with known patterns and
97  * asserts that the implementation matches the required algorithm.
98  * @return #STD_OK if the selfcheck is successful and #STD_NOT_OK otherwise
99  */
101 
102 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
103 
104 #endif /* FOXBMS__MXM_CRC8_H_ */
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
General macros and definitions for the whole platform.
#define must_check_return
Allows functions to generate warnings in GCC for unused returns.
Definition: general.h:95
STD_RETURN_TYPE_e must_check_return MXM_CRC8SelfTest(void)
Test the CRC8-algorithm with a known pattern.
Definition: mxm_crc8.c:124
uint8_t MXM_CRC8WithInitValue(uint16_t *pData, int32_t lenData, uint8_t crcInit)
Compute CRC8 (0xA6) with initial value.
Definition: mxm_crc8.c:105
uint8_t MXM_CRC8(uint16_t *pData, int32_t lenData)
Compute CRC8 with initial value set to 0x00.
Definition: mxm_crc8.c:120