foxBMS - Unit Tests  1.6.0
The foxBMS Unit Tests API Documentation
test_nxpfs85xx.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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_nxpfs85xx.c
44  * @author foxBMS Team
45  * @date 2020-04-06 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup UNIT_TEST_IMPLEMENTATION
49  * @prefix SBC
50  *
51  * @brief Tests for the sbc module
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "unity.h"
57 #include "Mockdiag.h"
58 #include "Mockdma.h"
59 #include "Mockfassert.h"
60 #include "Mockfram.h"
61 #include "Mockio.h"
62 #include "Mockmaster_info.h"
63 #include "Mockmcu.h"
64 #include "Mocksbc_fs8x.h"
65 #include "Mocksbc_fs8x_communication.h"
66 #include "Mockspi.h"
67 
68 #include "nxpfs85xx.h"
69 #include "test_assert_helper.h"
70 
71 #include <stdbool.h>
72 
73 /*========== Unit Testing Framework Directives ==============================*/
74 TEST_SOURCE_FILE("nxpfs85xx.c")
75 
76 TEST_INCLUDE_PATH("../../src/app/driver/config")
77 TEST_INCLUDE_PATH("../../src/app/driver/dma")
78 TEST_INCLUDE_PATH("../../src/app/driver/fram")
79 TEST_INCLUDE_PATH("../../src/app/driver/io")
80 TEST_INCLUDE_PATH("../../src/app/driver/sbc")
81 TEST_INCLUDE_PATH("../../src/app/driver/sbc/fs8x_driver")
82 TEST_INCLUDE_PATH("../../src/app/driver/spi")
83 TEST_INCLUDE_PATH("../../src/app/engine/diag")
84 TEST_INCLUDE_PATH("../../src/app/engine/hw_info")
85 
86 /*========== Definitions and Implementations for Unit Test ==================*/
87 #define REGISTER_TEST_VALUE (1234u)
88 
89 #define MAIN_REGISTER fs85xx_mcuSupervisor.mainRegister
90 #define FAILSAFE_REGISTER fs85xx_mcuSupervisor.fsRegister
91 
92 static spiDAT1_t spi_kSbcDataConfig = {
93  /* struct is implemented in the TI HAL and uses uppercase true and false */
94  .CS_HOLD = FALSE, /* The HW chip select signal is deactivated */
95  .WDEL = TRUE, /* No delay will be inserted */
96  .DFSEL = SPI_FMT_0, /* Data word format select */
97  .CSNR = 0x0, /* Chip select (CS) number; 0x01h for CS[0] */
98 };
99 
102  .pNode = spiREG2,
103  .pGioPort = &(spiREG2->PC3),
104  .csPin = 0u,
105 };
106 
108  .phase = 0u,
109  .finState = STD_NOT_OK,
110 };
111 
113  return 0;
114 }
115 
116 /*========== Setup and Teardown =============================================*/
117 void setUp(void) {
118 }
119 
120 void tearDown(void) {
121 }
122 
123 /*========== Test Cases =====================================================*/
124 
125 void testDoSomething(void) {
126 }
127 
129  TEST_ASSERT_EQUAL(STD_OK, TEST_FS85_CheckRegisterValues(0u, 0u));
130  TEST_ASSERT_EQUAL(STD_OK, TEST_FS85_CheckRegisterValues(UINT32_MAX, UINT32_MAX));
131  TEST_ASSERT_EQUAL(STD_NOT_OK, TEST_FS85_CheckRegisterValues(0u, 1u));
132  TEST_ASSERT_EQUAL(STD_NOT_OK, TEST_FS85_CheckRegisterValues(0u, UINT32_MAX));
133 }
134 
141 }
142 
174 
175  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.grl_flags, REGISTER_TEST_VALUE + 0u);
176  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.iOvervoltageUndervoltageSafeReaction1, REGISTER_TEST_VALUE + 1u);
177  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.iOvervoltageUndervoltageSafeReaction2, REGISTER_TEST_VALUE + 2u);
178  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.iWatchdogConfiguration, REGISTER_TEST_VALUE + 3u);
179  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.i_safe_inputs, REGISTER_TEST_VALUE + 4u);
180  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.iFailSafeSateMachine, REGISTER_TEST_VALUE + 5u);
181  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.i_svs, REGISTER_TEST_VALUE + 6u);
182  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.watchdogWindow, REGISTER_TEST_VALUE + 7u);
183  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.watchdogSeed, REGISTER_TEST_VALUE + 8u);
184  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.watchdogAnswer, REGISTER_TEST_VALUE + 9u);
185  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.overvoltageUndervoltageRegisterStatus, REGISTER_TEST_VALUE + 10u);
186  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.releaseFs0bPin, REGISTER_TEST_VALUE + 11u);
187  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.safeIos, REGISTER_TEST_VALUE + 12u);
188  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.diag_safety, REGISTER_TEST_VALUE + 13u);
189  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.intb_mask, REGISTER_TEST_VALUE + 14u);
190  TEST_ASSERT_EQUAL(FAILSAFE_REGISTER.states, REGISTER_TEST_VALUE + 15u);
191 }
192 
210 
211  TEST_ASSERT_EQUAL(MAIN_REGISTER.flag, REGISTER_TEST_VALUE + 0u);
212  TEST_ASSERT_EQUAL(MAIN_REGISTER.mode, REGISTER_TEST_VALUE + 1u);
213  TEST_ASSERT_EQUAL(MAIN_REGISTER.registerControl1, REGISTER_TEST_VALUE + 2u);
214  TEST_ASSERT_EQUAL(MAIN_REGISTER.registerControl2, REGISTER_TEST_VALUE + 3u);
215  TEST_ASSERT_EQUAL(MAIN_REGISTER.analogMultiplexer, REGISTER_TEST_VALUE + 4u);
216  TEST_ASSERT_EQUAL(MAIN_REGISTER.clock, REGISTER_TEST_VALUE + 5u);
217  TEST_ASSERT_EQUAL(MAIN_REGISTER.int_mask1, REGISTER_TEST_VALUE + 6u);
218  TEST_ASSERT_EQUAL(MAIN_REGISTER.int_mask2, REGISTER_TEST_VALUE + 7u);
219  TEST_ASSERT_EQUAL(MAIN_REGISTER.flag1, REGISTER_TEST_VALUE + 8u);
220  TEST_ASSERT_EQUAL(MAIN_REGISTER.flag2, REGISTER_TEST_VALUE + 9u);
221  TEST_ASSERT_EQUAL(MAIN_REGISTER.vmon_regx, REGISTER_TEST_VALUE + 10u);
222  TEST_ASSERT_EQUAL(MAIN_REGISTER.lvb1_svs, REGISTER_TEST_VALUE + 11u);
223  TEST_ASSERT_EQUAL(MAIN_REGISTER.memory0, REGISTER_TEST_VALUE + 12u);
224  TEST_ASSERT_EQUAL(MAIN_REGISTER.memory1, REGISTER_TEST_VALUE + 13u);
225  TEST_ASSERT_EQUAL(MAIN_REGISTER.deviceId, REGISTER_TEST_VALUE + 14u);
226 }
227 
229  FS8x_ReadRegister_IgnoreAndReturn(fs8xStatusOk);
232 }
233 
235  FS8x_WriteRegister_IgnoreAndReturn(fs8xStatusOk);
238 }
static DIAG_DIAGNOSIS_STATE_s diag
Definition: diag.c:71
@ STD_NOT_OK
Definition: fstd_types.h:84
@ STD_OK
Definition: fstd_types.h:83
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:77
@ fs8xStatusOk
void TEST_FS85_UpdateRegister(FS85_STATE_s *pInstance, bool isFailSafe, uint32_t registerAddress, uint32_t registerValue)
Definition: nxpfs85xx.c:1309
FS85_STATE_s fs85xx_mcuSupervisor
Definition: nxpfs85xx.c:87
STD_RETURN_TYPE_e TEST_FS85_GoToStandby(FS85_STATE_s *pInstance)
Definition: nxpfs85xx.c:1360
bool FS85_CheckIgnitionSignal(FS85_STATE_s *pInstance)
Check WAKE1 Signal at SBC.
Definition: nxpfs85xx.c:916
void TEST_FS85_UpdateFailSafeRegister(FS85_FS_REGISTER_s *pFsRegister, uint32_t registerAddress, uint32_t registerValue)
Definition: nxpfs85xx.c:1316
STD_RETURN_TYPE_e TEST_FS85_CheckRegisterValues(uint32_t registerValue, uint32_t expectedRegisterValue)
Definition: nxpfs85xx.c:1306
void TEST_FS85_UpdateMainRegister(FS85_MAIN_REGISTERS_s *pMainRegister, uint32_t registerAddress, uint32_t registerValue)
Definition: nxpfs85xx.c:1323
Header for the driver for the FRAM module.
#define FS8X_M_INT_MASK2_ADDR
#define FS8X_M_MEMORY1_ADDR
#define FS8X_FS_WD_ANSWER_ADDR
#define FS8X_M_REG_CTRL2_ADDR
Definition: sbc_fs8x_map.h:696
#define FS8X_FS_RELEASE_FS0B_ADDR
#define FS8X_FS_WD_WINDOW_ADDR
#define FS8X_M_DEVICEID_ADDR
#define FS8X_M_FLAG1_ADDR
#define FS8X_M_VMON_REGX_ADDR
#define FS8X_M_REG_CTRL1_ADDR
Definition: sbc_fs8x_map.h:432
#define FS8X_M_FLAG_ADDR
Definition: sbc_fs8x_map.h:57
#define FS8X_FS_WD_SEED_ADDR
#define FS8X_M_MODE_ADDR
Definition: sbc_fs8x_map.h:304
#define FS8X_FS_I_SAFE_INPUTS_ADDR
#define FS8X_FS_INTB_MASK_ADDR
#define FS8X_FS_SAFE_IOS_ADDR
#define FS8X_M_CLOCK_ADDR
#define FS8X_FS_I_OVUV_SAFE_REACTION1_ADDR
#define FS8X_FS_OVUVREG_STATUS_ADDR
#define FS8X_FS_I_FSSM_ADDR
#define FS8X_FS_I_WD_CFG_ADDR
#define FS8X_FS_DIAG_SAFETY_ADDR
#define FS8X_M_INT_MASK1_ADDR
#define FS8X_FS_I_SVS_ADDR
#define FS8X_M_LVB1_SVS_ADDR
#define FS8X_M_FLAG2_ADDR
#define FS8X_FS_I_OVUV_SAFE_REACTION2_ADDR
#define FS8X_M_AMUX_ADDR
Definition: sbc_fs8x_map.h:882
#define FS8X_FS_STATES_ADDR
#define FS8X_M_MEMORY0_ADDR
#define FS8X_FS_GRL_FLAGS_ADDR
uint8_t phase
Definition: fram_cfg.h:131
FS85_MAIN_REGISTERS_s mainRegister
Definition: nxpfs85xx.h:133
FS85_FS_REGISTER_s fsRegister
Definition: nxpfs85xx.h:134
spiDAT1_t * pConfig
Definition: spi_cfg.h:126
Helper for unit tests.
#define TEST_ASSERT_PASS_ASSERT(_code_under_test)
assert whether assert macro has passed
#define TEST_ASSERT_FAIL_ASSERT(_code_under_test)
assert whether assert macro has failed
static spiDAT1_t spi_kSbcDataConfig
SPI_INTERFACE_CONFIG_s spi_sbcMcuInterface
#define REGISTER_TEST_VALUE
void testFS85_UpdateFailSafeRegister(void)
#define FAILSAFE_REGISTER
void setUp(void)
void tearDown(void)
void testFS85_UpdateRegister(void)
#define MAIN_REGISTER
long FSYS_RaisePrivilege(void)
Raise privilege.
void testFS85_GoToStandby(void)
void testFS85_CheckRegisterValues(void)
void testDoSomething(void)
void testFS85_CheckIgnitionSignal(void)
FRAM_SBC_INIT_s fram_sbcInit
void testFS85_UpdateMainRegister(void)