foxBMS - Unit Tests  1.3.0
The foxBMS Unit Tests API Documentation
test_mxm_17852.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_17852.c
44  * @author foxBMS Team
45  * @date 2021-11-30 (date of creation)
46  * @updated 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup UNIT_TEST_IMPLEMENTATION
49  * @prefix MXM
50  *
51  * @brief Test for the Maxim 17852 driver.
52  *
53  * @details def
54  *
55  */
56 
57 /*========== Includes =======================================================*/
58 #include "unity.h"
59 #include "Mockafe_plausibility.h"
60 #include "Mockdatabase.h"
61 #include "Mockdiag.h"
62 #include "Mockfassert.h"
63 #include "Mockmxm_17841b.h"
64 #include "Mockmxm_41b_register_map.h"
65 #include "Mockmxm_battery_management.h"
66 #include "Mockmxm_cfg.h"
67 #include "Mockmxm_crc8.h"
68 #include "Mockmxm_registry.h"
69 #include "Mockos.h"
70 #include "Mocktsi.h"
71 
72 #include "database_cfg.h"
73 
74 #include "mxm_1785x.h"
75 #include "mxm_1785x_tools.h"
76 #include "test_assert_helper.h"
77 
78 TEST_FILE("mxm_17852.c")
79 
80 /*========== Definitions and Implementations for Unit Test ==================*/
81 
83 
86  .operationSubstate = MXM_INIT_ENTRY,
87  .allowStartup = false,
88  .operationRequested = false,
89  .firstMeasurementDone = false,
90  .stopRequested = false,
91  .openwireRequested = false,
92  .undervoltageAlert = false,
93  .dcByte = MXM_DC_EMPTY,
94  .mxmVoltageCellCounter = 0,
95  .highest5xDevice = 0,
96  .requestStatus5x = MXM_5X_STATE_UNSENT,
97  .batteryCmdBuffer =
98  {
99  .regAddress = (MXM_REG_NAME_e)0x00,
100  .lsb = 0x00,
101  .msb = 0x00,
102  .deviceAddress = 0x00,
103  .blocksize = 0,
104  .model = MXM_MODEL_ID_MAX17852,
105  },
106  .resultSelfCheck = STD_NOT_OK,
107  .selfCheck =
108  {
109  .crc = STD_NOT_OK,
110  .conv = STD_NOT_OK,
111  .firstSetBit = STD_NOT_OK,
112  .extractValueFromRegister = STD_NOT_OK,
113  .parseVoltageReadall = STD_NOT_OK,
114  .addressSpaceChecker = STD_NOT_OK,
115  .fmeaStatusASCI = STD_NOT_OK,
116  },
117  .pOpenwire_table = &mxm_tableOpenWire,
118 };
119 
121 
122 /*========== Setup and Teardown =============================================*/
123 void setUp(void) {
127 
128  /* delete rx buffer */
129  for (uint16_t i = 0u; i < MXM_RX_BUFFER_LENGTH; i++) {
130  mxm_instance.rxBuffer[i] = 0u;
131  }
132 }
133 
134 void tearDown(void) {
135 }
136 
137 /*========== Test Cases =====================================================*/
138 /** checks the model ID of the implementation */
139 void testGetModelId(void) {
141 }
Database configuration header.
@ DATA_BLOCK_ID_OPEN_WIRE_BASE
Definition: database_cfg.h:84
@ STD_NOT_OK
Definition: fstd_types.h:83
Headers for the driver for the MAX17841B ASCI and MAX1785x monitoring chip.
MXM_MODEL_ID_e MXM_GetModelIdOfDaisyChain(void)
returns the model ID of the daisy chain
Definition: mxm_17852.c:91
This is a collection of helper functions for the MAX1785x ICs.
@ MXM_INIT_ENTRY
@ MXM_STATEMACHINE_STATES_UNINITIALIZED
#define MXM_RX_BUFFER_LENGTH
Length of RX buffer.
@ MXM_MODEL_ID_MAX17852
@ MXM_DC_EMPTY
@ MXM_5X_STATE_UNSENT
MXM_REG_NAME_e
MAX1785x register names.
DATA_BLOCK_ID_e uniqueId
Definition: database_cfg.h:119
DATA_BLOCK_HEADER_s header
Definition: database_cfg.h:302
MXM_STATEMACHINE_OPERATION_STATES_e operationSubstate
uint8_t rxBuffer[MXM_RX_BUFFER_LENGTH]
MXM_STATEMACHINE_STATES_e state
MXM_5X_STATE_REQUEST_STATUS_e requestStatus5x
Helper for unit tests.
const bool mxm_allowSkippingPostInitSelfCheck
static MXM_MONITORING_INSTANCE_s mxm_instance
void testGetModelId(void)
void setUp(void)
void tearDown(void)
static DATA_BLOCK_OPEN_WIRE_s mxm_tableOpenWire