foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
diag_cbs_afe.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 diag_cbs_afe.c
44  * @author foxBMS Team
45  * @date 2021-02-17 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.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 #include "fstd_types.h"
58 
59 #include <stdint.h>
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Static Constant and Variable Definitions =======================*/
64 
65 /*========== Extern Constant and Variable Definitions =======================*/
66 
67 /*========== Static Function Prototypes =====================================*/
68 
69 /*========== Static Function Implementations ================================*/
70 
71 /*========== Extern Function Implementations ================================*/
72 extern void DIAG_ErrorAfe(
73  DIAG_ID_e diagId,
74  DIAG_EVENT_e event,
75  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
76  uint32_t stringNumber) {
77  FAS_ASSERT(diagId < DIAG_ID_MAX);
78  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
79  FAS_ASSERT(kpkDiagShim != NULL_PTR);
80  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
81 
83  if (event == DIAG_EVENT_RESET) {
84  kpkDiagShim->pTableError->afeCellVoltageInvalidError[stringNumber] = 0;
85  }
86  if (event == DIAG_EVENT_NOT_OK) {
87  kpkDiagShim->pTableError->afeCellVoltageInvalidError[stringNumber] = 1;
88  }
89  } else if (diagId == DIAG_ID_AFE_CELL_TEMPERATURE_MEAS_ERROR) {
90  if (event == DIAG_EVENT_RESET) {
91  kpkDiagShim->pTableError->afeCellTemperatureInvalidError[stringNumber] = false;
92  }
93  if (event == DIAG_EVENT_NOT_OK) {
94  kpkDiagShim->pTableError->afeCellTemperatureInvalidError[stringNumber] = true;
95  }
96  } else if (diagId == DIAG_ID_BASE_CELL_VOLTAGE_MEASUREMENT_TIMEOUT) {
97  if (event == DIAG_EVENT_RESET) {
99  }
100  if (event == DIAG_EVENT_NOT_OK) {
102  }
104  if (event == DIAG_EVENT_RESET) {
106  }
107  if (event == DIAG_EVENT_NOT_OK) {
109  }
111  if (event == DIAG_EVENT_RESET) {
113  }
114  if (event == DIAG_EVENT_NOT_OK) {
116  }
118  if (event == DIAG_EVENT_RESET) {
120  }
121  if (event == DIAG_EVENT_NOT_OK) {
123  }
124  }
125 }
126 
128  DIAG_ID_e diagId,
129  DIAG_EVENT_e event,
130  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
131  uint32_t stringNumber) {
132  FAS_ASSERT(diagId < DIAG_ID_MAX);
133  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
134  FAS_ASSERT(kpkDiagShim != NULL_PTR);
135  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
136 
137  if (diagId == DIAG_ID_AFE_SPI) {
138  if (event == DIAG_EVENT_RESET) {
139  kpkDiagShim->pTableError->afeCommunicationSpiError[stringNumber] = false;
140  }
141  if (event == DIAG_EVENT_NOT_OK) {
142  kpkDiagShim->pTableError->afeCommunicationSpiError[stringNumber] = true;
143  }
144  } else if (diagId == DIAG_ID_AFE_COM_INTEGRITY) {
145  if (event == DIAG_EVENT_RESET) {
146  kpkDiagShim->pTableError->afeCommunicationCrcError[stringNumber] = false;
147  }
148  if (event == DIAG_EVENT_NOT_OK) {
149  kpkDiagShim->pTableError->afeCommunicationCrcError[stringNumber] = true;
150  }
151  } else if (diagId == DIAG_ID_AFE_MUX) {
152  if (event == DIAG_EVENT_RESET) {
153  kpkDiagShim->pTableError->afeSlaveMultiplexerError[stringNumber] = false;
154  }
155  if (event == DIAG_EVENT_NOT_OK) {
156  kpkDiagShim->pTableError->afeSlaveMultiplexerError[stringNumber] = true;
157  }
158  } else if (diagId == DIAG_ID_AFE_CONFIG) {
159  if (event == DIAG_EVENT_RESET) {
160  kpkDiagShim->pTableError->afeConfigurationError[stringNumber] = false;
161  }
162  if (event == DIAG_EVENT_NOT_OK) {
163  kpkDiagShim->pTableError->afeConfigurationError[stringNumber] = true;
164  }
165  } else if (diagId == DIAG_ID_AFE_OPEN_WIRE) {
166  if (event == DIAG_EVENT_RESET) {
167  kpkDiagShim->pTableError->openWireDetectedError[stringNumber] = false;
168  }
169  if (event == DIAG_EVENT_NOT_OK) {
170  kpkDiagShim->pTableError->openWireDetectedError[stringNumber] = true;
171  }
172  } else { /* unknown DIAG_ID, assert */
174  }
175 }
176 
177 /*========== Externalized Static Function Implementations (Unit Test) =======*/
178 #ifdef UNITY_UNIT_TEST
179 #endif
#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:72
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:127
DIAG_EVENT_e
Definition: diag_cfg.h:266
@ DIAG_EVENT_RESET
Definition: diag_cfg.h:269
@ DIAG_EVENT_NOT_OK
Definition: diag_cfg.h:268
@ DIAG_EVENT_OK
Definition: diag_cfg.h:267
DIAG_ID_e
Definition: diag_cfg.h:176
@ DIAG_ID_AFE_MUX
Definition: diag_cfg.h:182
@ DIAG_ID_AFE_CELL_VOLTAGE_MEAS_ERROR
Definition: diag_cfg.h:191
@ DIAG_ID_AFE_CELL_TEMPERATURE_MEAS_ERROR
Definition: diag_cfg.h:192
@ DIAG_ID_BASE_CELL_TEMPERATURE_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:240
@ DIAG_ID_AFE_OPEN_WIRE
Definition: diag_cfg.h:230
@ DIAG_ID_AFE_COM_INTEGRITY
Definition: diag_cfg.h:181
@ DIAG_ID_BASE_CELL_VOLTAGE_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:238
@ DIAG_ID_MAX
Definition: diag_cfg.h:262
@ DIAG_ID_REDUNDANCY0_CELL_VOLTAGE_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:239
@ DIAG_ID_AFE_SPI
Definition: diag_cfg.h:180
@ DIAG_ID_AFE_CONFIG
Definition: diag_cfg.h:183
@ DIAG_ID_REDUNDANCY0_CELL_TEMPERATURE_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:241
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:255
#define FAS_TRAP
Define that evaluates to essential boolean false thus tripping an assert.
Definition: fassert.h:129
Definition of foxBMS standard types.
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:77
bool openWireDetectedError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:359
bool baseCellTemperatureMeasurementTimeoutError
Definition: database_cfg.h:346
bool redundancy0CellTemperatureMeasurementTimeoutError
Definition: database_cfg.h:347
bool redundancy0CellVoltageMeasurementTimeoutError
Definition: database_cfg.h:345
bool afeCommunicationCrcError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:338
bool afeSlaveMultiplexerError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:339
bool afeCommunicationSpiError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:340
bool afeConfigurationError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:341
bool afeCellVoltageInvalidError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:342
bool afeCellTemperatureInvalidError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:343
bool baseCellVoltageMeasurementTimeoutError
Definition: database_cfg.h:344
DATA_BLOCK_ERROR_STATE_s * pTableError
Definition: diag_cfg.h:166