foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
test_mxm_cfg.c
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 test_mxm_cfg.c
44  * @author foxBMS Team
45  * @date 2020-06-24 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup UNIT_TEST_IMPLEMENTATION
49  * @prefix TEST
50  *
51  * @brief Test of the mxm_cfg.c module
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "unity.h"
57 #include "Mockdiag.h"
58 #include "Mockfassert.h"
59 #include "Mockio.h"
60 #include "Mockspi.h"
61 #include "Mockspi_cfg.h"
62 
63 #include "mxm_cfg.h"
64 
65 /*========== Definitions and Implementations for Unit Test ==================*/
66 /* SPI interface configuration for MXM communication */
68  .pConfig = 0,
69  .pNode = 0,
70  .pGioPort = 0,
71  .csPin = 0,
72 };
73 
74 /*========== Setup and Teardown =============================================*/
75 void setUp(void) {
76 }
77 
78 void tearDown(void) {
79 }
80 
81 /*========== Test Cases =====================================================*/
82 
84  /* check if the right pinset configs are called */
85  IO_SetPinDirectionToOutput_Expect((uint32_t *)&MXM_17841B_GIOPORT->DIR, MXM_17841B_SHTNDL_PIN);
86  IO_PinReset_Expect((uint32_t *)&MXM_17841B_GIOPORT->DOUT, MXM_17841B_SHTNDL_PIN);
87  SPI_SetFunctional_Expect(NULL_PTR, SPI_PIN_SIMO, true);
88  SPI_SetFunctional_IgnoreArg_pNode();
89  SPI_SetFunctional_Expect(NULL_PTR, SPI_PIN_SOMI, true);
90  SPI_SetFunctional_IgnoreArg_pNode();
92 }
93 
95  IO_PinReset_Expect((uint32_t *)&MXM_17841B_GIOPORT->DOUT, MXM_17841B_SHTNDL_PIN);
97 }
98 
100  IO_PinSet_Expect((uint32_t *)&MXM_17841B_GIOPORT->DOUT, MXM_17841B_SHTNDL_PIN);
102 }
103 
105  SPI_CheckInterfaceAvailable_ExpectAndReturn(spi_mxmInterface.pNode, STD_OK);
106  TEST_ASSERT_EQUAL(STD_OK, MXM_GetSPIStateReady());
107 
108  SPI_CheckInterfaceAvailable_ExpectAndReturn(spi_mxmInterface.pNode, STD_NOT_OK);
109  TEST_ASSERT_EQUAL(STD_NOT_OK, MXM_GetSPIStateReady());
110 }
111 
112 void testMXM_SendData(void) {
113  /* check if the message is passed properly to the HAL */
114  uint16_t buffer = 0;
115  uint16_t bufferLength = 1;
116 
117  SPI_TransmitData_ExpectAndReturn(&spi_mxmInterface, &buffer, bufferLength, STD_OK);
118  DIAG_CheckEvent_ExpectAndReturn(STD_OK, DIAG_ID_AFE_SPI, DIAG_STRING, 0u, STD_OK);
119  TEST_ASSERT_EQUAL(STD_OK, MXM_SendData(&buffer, bufferLength));
120 }
121 
123  /* check if the message is passed properly to the HAL */
124  uint16_t buffer = 0;
125  uint16_t bufferLength = 1;
126 
127  SPI_TransmitReceiveData_ExpectAndReturn(&spi_mxmInterface, &buffer, &buffer, bufferLength, STD_OK);
128  DIAG_CheckEvent_ExpectAndReturn(STD_OK, DIAG_ID_AFE_SPI, DIAG_STRING, 0u, STD_OK);
129  TEST_ASSERT_EQUAL(STD_OK, MXM_ReceiveData(&buffer, &buffer, bufferLength));
130 }
@ DIAG_STRING
Definition: diag_cfg.h:252
@ DIAG_ID_AFE_SPI
Definition: diag_cfg.h:161
@ STD_NOT_OK
Definition: fstd_types.h:83
@ STD_OK
Definition: fstd_types.h:82
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:76
STD_RETURN_TYPE_e MXM_ReceiveData(uint16_t *txBuffer, uint16_t *rxBuffer, uint16_t length)
Send and Receive data over SPI.
Definition: mxm_cfg.c:97
void MXM_InitializeMonitoringPins(void)
Initialize the pins connected to the MAX17841B.
Definition: mxm_cfg.c:75
STD_RETURN_TYPE_e MXM_GetSPIStateReady(void)
Return whether SPI interface is ready.
Definition: mxm_cfg.c:84
void MXM_ShutDownBridgeIc(void)
Pulls the shutdown of the bridge IC low.
Definition: mxm_cfg.c:107
void MXM_EnableBridgeIc(void)
Pulls the shutdown of the bridge IC high.
Definition: mxm_cfg.c:111
STD_RETURN_TYPE_e MXM_SendData(uint16_t *txBuffer, uint16_t length)
Transmit data over SPI.
Definition: mxm_cfg.c:88
Header for the configuration for the Maxim monitoring chip.
#define MXM_17841B_GIOPORT
Definition: mxm_cfg.h:73
#define MXM_17841B_SHTNDL_PIN
Definition: mxm_cfg.h:74
spiDAT1_t * pConfig
Definition: spi_cfg.h:124
spiBASE_t * pNode
Definition: spi_cfg.h:125
void testMXM_ReceiveData(void)
Definition: test_mxm_cfg.c:122
SPI_INTERFACE_CONFIG_s spi_mxmInterface
Definition: test_mxm_cfg.c:67
void testMXM_EnableBridgeIc(void)
Definition: test_mxm_cfg.c:99
void testMXM_SendData(void)
Definition: test_mxm_cfg.c:112
void setUp(void)
Definition: test_mxm_cfg.c:75
void testMXM_InitializeMonitoringPins(void)
Definition: test_mxm_cfg.c:83
void tearDown(void)
Definition: test_mxm_cfg.c:78
void testMXM_ShutDownBridgeIc(void)
Definition: test_mxm_cfg.c:94
void testMXM_GetSpiStateReady(void)
Definition: test_mxm_cfg.c:104