foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
diag_cbs_afe.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 diag_cbs_afe.c
44  * @author foxBMS Team
45  * @date 2021-02-17 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup ENGINE
49  * @prefix DIAG
50  *
51  * @brief Diagnosis driver implementation
52  * @details TODO
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "diag_cbs.h"
57 
58 /*========== Macros and Definitions =========================================*/
59 
60 /*========== Static Constant and Variable Definitions =======================*/
61 
62 /*========== Extern Constant and Variable Definitions =======================*/
63 
64 /*========== Static Function Prototypes =====================================*/
65 
66 /*========== Static Function Implementations ================================*/
67 
68 /*========== Extern Function Implementations ================================*/
69 extern void DIAG_ErrorAfe(
70  DIAG_ID_e diagId,
71  DIAG_EVENT_e event,
72  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
73  uint32_t stringNumber) {
74  FAS_ASSERT(diagId < DIAG_ID_MAX);
75  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
76  FAS_ASSERT(kpkDiagShim != NULL_PTR);
77  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
78 
80  if (event == DIAG_EVENT_RESET) {
81  kpkDiagShim->pTableError->afeCellVoltageError[stringNumber] = 0;
82  }
83  if (event == DIAG_EVENT_NOT_OK) {
84  kpkDiagShim->pTableError->afeCellVoltageError[stringNumber] = 1;
85  }
86  } else if (diagId == DIAG_ID_AFE_CELL_TEMPERATURE_MEAS_ERROR) {
87  if (event == DIAG_EVENT_RESET) {
88  kpkDiagShim->pTableError->afeCellTemperatureError[stringNumber] = 0;
89  }
90  if (event == DIAG_EVENT_NOT_OK) {
91  kpkDiagShim->pTableError->afeCellTemperatureError[stringNumber] = 1;
92  }
93  } else if (diagId == DIAG_ID_BASE_CELL_VOLTAGE_MEASUREMENT_TIMEOUT) {
94  if (event == DIAG_EVENT_RESET) {
96  }
97  if (event == DIAG_EVENT_NOT_OK) {
99  }
101  if (event == DIAG_EVENT_RESET) {
103  }
104  if (event == DIAG_EVENT_NOT_OK) {
106  }
108  if (event == DIAG_EVENT_RESET) {
110  }
111  if (event == DIAG_EVENT_NOT_OK) {
113  }
115  if (event == DIAG_EVENT_RESET) {
117  }
118  if (event == DIAG_EVENT_NOT_OK) {
120  }
121  }
122 }
123 
125  DIAG_ID_e diagId,
126  DIAG_EVENT_e event,
127  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
128  uint32_t stringNumber) {
129  FAS_ASSERT(diagId < DIAG_ID_MAX);
130  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
131  FAS_ASSERT(kpkDiagShim != NULL_PTR);
132  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
133 
134  if (diagId == DIAG_ID_AFE_SPI) {
135  if (event == DIAG_EVENT_RESET) {
136  kpkDiagShim->pTableError->spiError[stringNumber] = 0;
137  }
138  if (event == DIAG_EVENT_NOT_OK) {
139  kpkDiagShim->pTableError->spiError[stringNumber] = 1;
140  }
141  } else if (diagId == DIAG_ID_AFE_COM_INTEGRITY) {
142  if (event == DIAG_EVENT_RESET) {
143  kpkDiagShim->pTableError->crcError[stringNumber] = 0;
144  }
145  if (event == DIAG_EVENT_NOT_OK) {
146  kpkDiagShim->pTableError->crcError[stringNumber] = 1;
147  }
148  } else if (diagId == DIAG_ID_AFE_MUX) {
149  if (event == DIAG_EVENT_RESET) {
150  kpkDiagShim->pTableError->muxError[stringNumber] = 0;
151  }
152  if (event == DIAG_EVENT_NOT_OK) {
153  kpkDiagShim->pTableError->muxError[stringNumber] = 1;
154  }
155  } else if (diagId == DIAG_ID_AFE_CONFIG) {
156  if (event == DIAG_EVENT_RESET) {
157  kpkDiagShim->pTableError->afeConfigurationError[stringNumber] = 0;
158  }
159  if (event == DIAG_EVENT_NOT_OK) {
160  kpkDiagShim->pTableError->afeConfigurationError[stringNumber] = 1;
161  }
162  } else if (diagId == DIAG_ID_AFE_OPEN_WIRE) {
163  if (event == DIAG_EVENT_RESET) {
164  kpkDiagShim->pTableError->open_wire[stringNumber] = 0;
165  }
166  if (event == DIAG_EVENT_NOT_OK) {
167  kpkDiagShim->pTableError->open_wire[stringNumber] = 1;
168  }
169  } else { /* unknown DIAG_ID, assert */
171  }
172 }
173 
174 /*========== Externalized Static Function Implementations (Unit Test) =======*/
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
Diagnosis driver header.
void DIAG_ErrorAfe(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for AFE related events
Definition: diag_cbs_afe.c:69
void DIAG_ErrorAfeDriver(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for AFE module related events
Definition: diag_cbs_afe.c:124
DIAG_EVENT_e
Definition: diag_cfg.h:237
@ DIAG_EVENT_RESET
Definition: diag_cfg.h:240
@ DIAG_EVENT_NOT_OK
Definition: diag_cfg.h:239
@ DIAG_EVENT_OK
Definition: diag_cfg.h:238
DIAG_ID_e
Definition: diag_cfg.h:157
@ DIAG_ID_AFE_MUX
Definition: diag_cfg.h:163
@ DIAG_ID_AFE_CELL_VOLTAGE_MEAS_ERROR
Definition: diag_cfg.h:171
@ DIAG_ID_AFE_CELL_TEMPERATURE_MEAS_ERROR
Definition: diag_cfg.h:172
@ DIAG_ID_BASE_CELL_TEMPERATURE_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:219
@ DIAG_ID_AFE_OPEN_WIRE
Definition: diag_cfg.h:210
@ DIAG_ID_AFE_COM_INTEGRITY
Definition: diag_cfg.h:162
@ DIAG_ID_BASE_CELL_VOLTAGE_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:217
@ DIAG_ID_MAX
Definition: diag_cfg.h:233
@ DIAG_ID_REDUNDANCY0_CELL_VOLTAGE_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:218
@ DIAG_ID_AFE_SPI
Definition: diag_cfg.h:161
@ DIAG_ID_AFE_CONFIG
Definition: diag_cfg.h:164
@ DIAG_ID_REDUNDANCY0_CELL_TEMPERATURE_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:220
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:248
#define FAS_TRAP
Define that evaluates to essential boolean false thus tripping an assert.
Definition: fassert.h:126
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:76
uint8_t baseCellVoltageMeasurementTimeout
Definition: database_cfg.h:340
uint8_t redundancy0CellVoltageMeasurementTimeout
Definition: database_cfg.h:341
uint8_t baseCellTemperatureMeasurementTimeout
Definition: database_cfg.h:342
uint8_t crcError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:334
uint8_t afeConfigurationError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:337
uint8_t redundancy0CellTemperatureMeasurementTimeout
Definition: database_cfg.h:343
uint8_t afeCellTemperatureError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:339
uint8_t muxError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:335
uint8_t open_wire[BS_NR_OF_STRINGS]
Definition: database_cfg.h:359
uint8_t afeCellVoltageError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:338
uint8_t spiError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:336
DATA_BLOCK_ERRORSTATE_s * pTableError
Definition: diag_cfg.h:147