foxBMS - Unit Tests  1.3.0
The foxBMS Unit Tests API Documentation
mxm_crc8.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 mxm_crc8.h
44  * @author foxBMS Team
45  * @date 2019-02-05 (date of creation)
46  * @updated 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup DRIVERS
49  * @prefix MXM
50  *
51  * @brief Headers for the CRC8 calculation for Maxim Integrated
52  * Monitoring devices
53  *
54  * @details This module supports the calculation of a CRC8 based on the
55  * polynomial described in the Maxim data sheets.
56  * The polynomial is 0xA6.
57  *
58  */
59 
60 #ifndef FOXBMS__MXM_CRC8_H_
61 #define FOXBMS__MXM_CRC8_H_
62 
63 /*========== Includes =======================================================*/
64 #include "general.h"
65 
66 /*========== Macros and Definitions =========================================*/
67 
68 /*========== Extern Constant and Variable Declarations ======================*/
69 
70 /*========== Extern Function Prototypes =====================================*/
71 
72 /**
73  * @brief Compute CRC8 with initial value set to 0x00.
74  * @details Computes the CRC8 for the given data with the given length
75  * with the polynomial 0xA6. This function calls
76  * #MXM_CRC8WithInitValue() with CRC set to 0x00.
77  * The result should be 0x00 if you include the CRC into
78  * the datastream.
79  * @param[in] pData array-pointer with data to be cyclic redundancy checked
80  * @param[in] lenData length of array
81  * @return uint8_t containing the computed CRC
82  */
83 extern uint8_t MXM_CRC8(uint16_t *pData, int32_t lenData);
84 
85 /**
86  * @brief Test the CRC8-algorithm with a known pattern.
87  * @details Tests the CRC8-algorithm with known patterns and
88  * asserts that the implementation matches the required algorithm.
89  * @return #STD_OK if the selfcheck is successful and #STD_NOT_OK otherwise
90  */
92 
93 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
94 
95 #endif /* FOXBMS__MXM_CRC8_H_ */
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
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:88
STD_RETURN_TYPE_e must_check_return MXM_CRC8SelfTest(void)
Test the CRC8-algorithm with a known pattern.
Definition: mxm_crc8.c:140
uint8_t MXM_CRC8(uint16_t *pData, int32_t lenData)
Compute CRC8 with initial value set to 0x00.
Definition: mxm_crc8.c:133