foxBMS - Unit Tests  1.2.1
The foxBMS Unit Tests API Documentation
test_mxm_crc8.c
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 test_mxm_crc8.c
44  * @author foxBMS Team
45  * @date 2020-03-13 (date of creation)
46  * @updated 2020-04-27 (date of last update)
47  * @ingroup UNIT_TEST_IMPLEMENTATION
48  * @prefix MXM
49  *
50  * @brief Test for the Maxim CRC8 implementation.
51  *
52  * @details def
53  *
54  */
55 
56 /*========== Includes =======================================================*/
57 #include "unity.h"
58 
59 #include "mxm_crc8.h"
60 #include "test_assert_helper.h"
61 
62 /*========== Definitions and Implementations for Unit Test ==================*/
63 
64 /*========== Setup and Teardown =============================================*/
65 void setUp(void) {
66 }
67 
68 void tearDown(void) {
69 }
70 
71 /*========== Test Cases =====================================================*/
73  TEST_ASSERT_PASS_ASSERT(TEST_ASSERT_EQUAL_HEX8(STD_OK, MXM_CRC8SelfTest()));
74 }
75 
76 void testCRC8Sequence1(void) {
77  uint16_t test_sequence[4] = {0x02u, 0x12u, 0xB1u, 0xB2u};
78  TEST_ASSERT_EQUAL(0xC4u, MXM_CRC8(test_sequence, 4));
79 }
80 
81 void testCRC8Sequence2(void) {
82  uint16_t test_sequence[3] = {0x03u, 0x12u, 0x00u};
83  TEST_ASSERT_EQUAL(0xCBu, MXM_CRC8(test_sequence, 3));
84 }
85 
86 void testCRC8Sequence3(void) {
87  uint16_t test_sequence[10] = {0x02u, 0x5Bu, 0x12u, 0x42u, 0xFFu, 0xD3u, 0x13u, 0x77u, 0xA1u, 0x31u};
88  TEST_ASSERT_EQUAL(0x7Eu, MXM_CRC8(test_sequence, 10));
89 }
90 
91 void testCRC8Sequence4(void) {
92  uint16_t test_sequence[3] = {0x03u, 0x66u, 0x00u};
93  TEST_ASSERT_EQUAL(0x43u, MXM_CRC8(test_sequence, 3));
94 }
@ STD_OK
Definition: fstd_types.h:81
STD_RETURN_TYPE_e must_check_return MXM_CRC8SelfTest(void)
Test the CRC8-algorithm with a known pattern.
Definition: mxm_crc8.c:135
uint8_t MXM_CRC8(uint16_t *pData, int32_t lenData)
Compute CRC8 with initial value set to 0x00.
Definition: mxm_crc8.c:130
Headers for the CRC8 calculation for Maxim Integrated Monitoring devices.
Helper for unit tests.
#define TEST_ASSERT_PASS_ASSERT(_code_under_test)
assert whether assert macro has passed
void testCRC8SelfCheckShouldPass(void)
Definition: test_mxm_crc8.c:72
void testCRC8Sequence3(void)
Definition: test_mxm_crc8.c:86
void testCRC8Sequence4(void)
Definition: test_mxm_crc8.c:91
void setUp(void)
Definition: test_mxm_crc8.c:65
void tearDown(void)
Definition: test_mxm_crc8.c:68
void testCRC8Sequence1(void)
Definition: test_mxm_crc8.c:76
void testCRC8Sequence2(void)
Definition: test_mxm_crc8.c:81