foxBMS - Unit Tests  1.1.2
The foxBMS Unit Tests API Documentation
test_spi.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_spi.c
44  * @author foxBMS Team
45  * @date 2020-04-01 (date of creation)
46  * @updated 2021-06-16 (date of last update)
47  * @ingroup UNIT_TEST_IMPLEMENTATION
48  * @prefix TEST
49  *
50  * @brief Tests for the spi module
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "unity.h"
56 #include "MockHL_spi.h"
57 #include "MockHL_sys_dma.h"
58 #include "Mockio.h"
59 #include "Mockmcu.h"
60 #include "Mockos.h"
61 
62 #include "dma_cfg.h"
63 #include "spi_cfg.h"
64 
65 #include "spi.h"
66 #include "test_assert_helper.h"
67 
68 /*========== Definitions and Implementations for Unit Test ==================*/
69 
70 long FSYS_RaisePrivilege(void) {
71  return 0;
72 }
73 
74 /** mock for testing with an SPI handle */
75 spiBASE_t spiMockHandle = {0};
76 
77 spi_config_reg_t spiMockConfigRegister = {0};
78 
79 /*========== Setup and Teardown =============================================*/
80 void setUp(void) {
81  /* make sure PC0 of config register is clean */
82  spiMockConfigRegister.CONFIG_PC0 = 0;
83 }
84 
85 void tearDown(void) {
86 }
87 
88 /*========== Test Cases =====================================================*/
89 /** simple API test that function guards against null pointer */
92 }
93 
94 /** test intended function of SPI_SetFunctional() for setting a bit */
96  /** fake a config register that is null and inject into function */
97  spiMockConfigRegister.CONFIG_PC0 = 0;
98  spi1GetConfigValue_Expect(NULL_PTR, CurrentValue);
99  spi1GetConfigValue_IgnoreArg_config_reg();
100  spi1GetConfigValue_ReturnThruPtr_config_reg(&spiMockConfigRegister);
101 
102  /* the function should call spiSetFunctional with a 1 at bit 10 */
103  spiSetFunctional_Expect(spiREG1, ((uint32_t)1u << 10u));
104 
105  SPI_SetFunctional(spiREG1, 10, true);
106 }
107 
108 /** test intended function of SPI_SetFunctional() for clearing a bit */
110  /** fake a config register that is UINT32_MAX and inject into function */
111  spiMockConfigRegister.CONFIG_PC0 = UINT32_MAX;
112  spi1GetConfigValue_Expect(NULL_PTR, CurrentValue);
113  spi1GetConfigValue_IgnoreArg_config_reg();
114  spi1GetConfigValue_ReturnThruPtr_config_reg(&spiMockConfigRegister);
115 
116  /* the function should call spiSetFunctional with a 0 at bit 10 */
117  spiSetFunctional_Expect(spiREG1, ~((uint32_t)1u << 10u));
118 
119  SPI_SetFunctional(spiREG1, 10, false);
120 }
121 
122 /** test usage of right API functions for SPI1 */
124  /* this test will fail if another function than the intended function is
125  called */
126  spi1GetConfigValue_Ignore();
127  spiSetFunctional_Ignore();
128  SPI_SetFunctional(spiREG1, 0, false);
129 }
130 
131 /** test usage of right API functions for SPI2 */
133  /* this test will fail if another function than the intended function is
134  called */
135  spi2GetConfigValue_Ignore();
136  spiSetFunctional_Ignore();
137  SPI_SetFunctional(spiREG2, 0, false);
138 }
139 
140 /** test usage of right API functions for SPI3 */
142  /* this test will fail if another function than the intended function is
143  called */
144  spi3GetConfigValue_Ignore();
145  spiSetFunctional_Ignore();
146  SPI_SetFunctional(spiREG3, 0, false);
147 }
148 
149 /** test usage of right API functions for SPI4 */
151  /* this test will fail if another function than the intended function is
152  called */
153  spi4GetConfigValue_Ignore();
154  spiSetFunctional_Ignore();
155  SPI_SetFunctional(spiREG4, 0, false);
156 }
157 
158 /** test usage of right API functions for SPI5 */
160  /* this test will fail if another function than the intended function is
161  called */
162  spi5GetConfigValue_Ignore();
163  spiSetFunctional_Ignore();
164  SPI_SetFunctional(spiREG5, 0, false);
165 }
Headers for the configuration for the DMA module.
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:66
void SPI_SetFunctional(spiBASE_t *pNode, enum spiPinSelect bit, bool hardwareControlled)
Sets the functional of a SPI pin.
Definition: spi.c:430
Headers for the driver for the SPI module.
Headers for the configuration for the SPI module.
Helper for unit tests.
#define TEST_ASSERT_FAIL_ASSERT(_code_under_test)
assert whether assert macro has failed
spiBASE_t spiMockHandle
Definition: test_spi.c:75
void testSPI_SetFunctionalRightApiSpi5(void)
Definition: test_spi.c:159
void testSPI_SetFunctionalRightApiSpi2(void)
Definition: test_spi.c:132
void testSPI_SetFunctionalTestIntendedFunctionClear(void)
Definition: test_spi.c:109
void testSPI_SetFunctionalTestIntendedFunctionSet(void)
Definition: test_spi.c:95
void testSPI_SetFunctionalRightApiSpi4(void)
Definition: test_spi.c:150
void testSPI_SetFunctionalNullPointer(void)
Definition: test_spi.c:90
void setUp(void)
Definition: test_spi.c:80
void tearDown(void)
Definition: test_spi.c:85
void testSPI_SetFunctionalRightApiSpi3(void)
Definition: test_spi.c:141
spi_config_reg_t spiMockConfigRegister
Definition: test_spi.c:77
long FSYS_RaisePrivilege(void)
raise privilege
Definition: test_spi.c:70
void testSPI_SetFunctionalRightApiSpi1(void)
Definition: test_spi.c:123