foxBMS - Unit Tests  1.4.1
The foxBMS Unit Tests API Documentation
diag_cbs_current.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_current.c
44  * @author foxBMS Team
45  * @date 2021-02-17 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
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 ================================*/
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 
79  switch (diagId) {
81  if (event == DIAG_EVENT_RESET) {
82  kpkDiagShim->pTableMsl->cellChargeOvercurrent[stringNumber] = 0;
83  } else if (event == DIAG_EVENT_NOT_OK) {
84  kpkDiagShim->pTableMsl->cellChargeOvercurrent[stringNumber] = 1;
85  } else {
86  /* no relevant event, do nothing */
87  }
88  break;
90  if (event == DIAG_EVENT_RESET) {
91  kpkDiagShim->pTableRsl->cellChargeOvercurrent[stringNumber] = 0;
92  } else if (event == DIAG_EVENT_NOT_OK) {
93  kpkDiagShim->pTableRsl->cellChargeOvercurrent[stringNumber] = 1;
94  } else {
95  /* no relevant event, do nothing */
96  }
97  break;
99  if (event == DIAG_EVENT_RESET) {
100  kpkDiagShim->pTableMol->cellChargeOvercurrent[stringNumber] = 0;
101  } else if (event == DIAG_EVENT_NOT_OK) {
102  kpkDiagShim->pTableMol->cellChargeOvercurrent[stringNumber] = 1;
103  } else {
104  /* no relevant event, do nothing */
105  }
106  break;
108  if (event == DIAG_EVENT_RESET) {
109  kpkDiagShim->pTableMsl->stringChargeOvercurrent[stringNumber] = 0;
110  } else if (event == DIAG_EVENT_NOT_OK) {
111  kpkDiagShim->pTableMsl->stringChargeOvercurrent[stringNumber] = 1;
112  } else {
113  /* no relevant event, do nothing */
114  }
115  break;
117  if (event == DIAG_EVENT_RESET) {
118  kpkDiagShim->pTableRsl->stringChargeOvercurrent[stringNumber] = 0;
119  } else if (event == DIAG_EVENT_NOT_OK) {
120  kpkDiagShim->pTableRsl->stringChargeOvercurrent[stringNumber] = 1;
121  } else {
122  /* no relevant event, do nothing */
123  }
124  break;
126  if (event == DIAG_EVENT_RESET) {
127  kpkDiagShim->pTableMol->stringChargeOvercurrent[stringNumber] = 0;
128  } else if (event == DIAG_EVENT_NOT_OK) {
129  kpkDiagShim->pTableMol->stringChargeOvercurrent[stringNumber] = 1;
130  } else {
131  /* no relevant event, do nothing */
132  }
133  break;
134 
136  if (event == DIAG_EVENT_RESET) {
137  kpkDiagShim->pTableMsl->packChargeOvercurrent = 0;
138  } else if (event == DIAG_EVENT_NOT_OK) {
139  kpkDiagShim->pTableMsl->packChargeOvercurrent = 1;
140  } else {
141  /* no relevant event, do nothing */
142  }
143  break;
144 
145  default:
147  break;
148  }
149 }
150 
152  DIAG_ID_e diagId,
153  DIAG_EVENT_e event,
154  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
155  uint32_t stringNumber) {
156  FAS_ASSERT(diagId < DIAG_ID_MAX);
157  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
158  FAS_ASSERT(kpkDiagShim != NULL_PTR);
159  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
160 
161  switch (diagId) {
163  if (event == DIAG_EVENT_RESET) {
164  kpkDiagShim->pTableMsl->cellDischargeOvercurrent[stringNumber] = 0;
165  } else if (event == DIAG_EVENT_NOT_OK) {
166  kpkDiagShim->pTableMsl->cellDischargeOvercurrent[stringNumber] = 1;
167  } else {
168  /* no relevant event, do nothing */
169  }
170  break;
172  if (event == DIAG_EVENT_RESET) {
173  kpkDiagShim->pTableRsl->cellDischargeOvercurrent[stringNumber] = 0;
174  } else if (event == DIAG_EVENT_NOT_OK) {
175  kpkDiagShim->pTableRsl->cellDischargeOvercurrent[stringNumber] = 1;
176  } else {
177  /* no relevant event, do nothing */
178  }
179  break;
181  if (event == DIAG_EVENT_RESET) {
182  kpkDiagShim->pTableMol->cellDischargeOvercurrent[stringNumber] = 0;
183  } else if (event == DIAG_EVENT_NOT_OK) {
184  kpkDiagShim->pTableMol->cellDischargeOvercurrent[stringNumber] = 1;
185  } else {
186  /* no relevant event, do nothing */
187  }
188  break;
190  if (event == DIAG_EVENT_RESET) {
191  kpkDiagShim->pTableMsl->stringDischargeOvercurrent[stringNumber] = 0;
192  } else if (event == DIAG_EVENT_NOT_OK) {
193  kpkDiagShim->pTableMsl->stringDischargeOvercurrent[stringNumber] = 1;
194  } else {
195  /* no relevant event, do nothing */
196  }
197  break;
199  if (event == DIAG_EVENT_RESET) {
200  kpkDiagShim->pTableRsl->stringDischargeOvercurrent[stringNumber] = 0;
201  } else if (event == DIAG_EVENT_NOT_OK) {
202  kpkDiagShim->pTableRsl->stringDischargeOvercurrent[stringNumber] = 1;
203  } else {
204  /* no relevant event, do nothing */
205  }
206  break;
208  if (event == DIAG_EVENT_RESET) {
209  kpkDiagShim->pTableMol->stringDischargeOvercurrent[stringNumber] = 0;
210  } else if (event == DIAG_EVENT_NOT_OK) {
211  kpkDiagShim->pTableMol->stringDischargeOvercurrent[stringNumber] = 1;
212  } else {
213  /* no relevant event, do nothing */
214  }
215  break;
217  if (event == DIAG_EVENT_RESET) {
218  kpkDiagShim->pTableMsl->packDischargeOvercurrent = 0;
219  } else if (event == DIAG_EVENT_NOT_OK) {
220  kpkDiagShim->pTableMsl->packDischargeOvercurrent = 1;
221  } else {
222  /* no relevant event, do nothing */
223  }
224  break;
225 
226  default:
228  break;
229  }
230 }
231 
233  DIAG_ID_e diagId,
234  DIAG_EVENT_e event,
235  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
236  uint32_t stringNumber) {
237  FAS_ASSERT(diagId < DIAG_ID_MAX);
238  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
239  FAS_ASSERT(kpkDiagShim != NULL_PTR);
240  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
241 
242  switch (diagId) {
244  if (event == DIAG_EVENT_RESET) {
245  kpkDiagShim->pTableError->currentMeasurementTimeout[stringNumber] = 0u;
246  } else if (event == DIAG_EVENT_NOT_OK) {
247  kpkDiagShim->pTableError->currentMeasurementTimeout[stringNumber] = 1u;
248  } else {
249  /* no relevant event, do nothing */
250  }
251  break;
252 
254  if (event == DIAG_EVENT_RESET) {
255  kpkDiagShim->pTableError->currentMeasurementError[stringNumber] = 0u;
256  } else if (event == DIAG_EVENT_NOT_OK) {
257  kpkDiagShim->pTableError->currentMeasurementError[stringNumber] = 1u;
258  } else {
259  /* no relevant event, do nothing */
260  }
261  break;
262 
263  default:
265  break;
266  }
267 }
268 
270  DIAG_ID_e diagId,
271  DIAG_EVENT_e event,
272  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
273  uint32_t stringNumber) {
274  FAS_ASSERT(diagId < DIAG_ID_MAX);
275  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
276  FAS_ASSERT(kpkDiagShim != NULL_PTR);
277  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
278 
279  switch (diagId) {
281  if (event == DIAG_EVENT_RESET) {
282  kpkDiagShim->pTableError->currentOnOpenString[stringNumber] = 0u;
283  } else if (event == DIAG_EVENT_NOT_OK) {
284  kpkDiagShim->pTableError->currentOnOpenString[stringNumber] = 1u;
285  } else {
286  /* no relevant event, do nothing */
287  }
288  break;
289 
290  default:
292  break;
293  }
294 }
295 
296 /*========== Externalized Static Function Implementations (Unit Test) =======*/
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
Diagnosis driver header.
void DIAG_ErrorCurrentOnOpenString(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for overcurrent charge events
void DIAG_ErrorCurrentMeasurement(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for current measurement related events
void DIAG_ErrorOvercurrentCharge(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for overcurrent charge events
void DIAG_ErrorOvercurrentDischarge(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for overcurrent discharge events
DIAG_EVENT_e
Definition: diag_cfg.h:256
@ DIAG_EVENT_RESET
Definition: diag_cfg.h:259
@ DIAG_EVENT_NOT_OK
Definition: diag_cfg.h:258
@ DIAG_EVENT_OK
Definition: diag_cfg.h:257
DIAG_ID_e
Definition: diag_cfg.h:174
@ DIAG_ID_PACK_OVERCURRENT_CHARGE_MSL
Definition: diag_cfg.h:223
@ DIAG_ID_OVERCURRENT_CHARGE_CELL_RSL
Definition: diag_cfg.h:212
@ DIAG_ID_CURRENT_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:239
@ DIAG_ID_STRING_OVERCURRENT_DISCHARGE_MOL
Definition: diag_cfg.h:222
@ DIAG_ID_STRING_OVERCURRENT_DISCHARGE_RSL
Definition: diag_cfg.h:221
@ DIAG_ID_STRING_OVERCURRENT_CHARGE_RSL
Definition: diag_cfg.h:218
@ DIAG_ID_OVERCURRENT_DISCHARGE_CELL_MSL
Definition: diag_cfg.h:214
@ DIAG_ID_STRING_OVERCURRENT_CHARGE_MSL
Definition: diag_cfg.h:217
@ DIAG_ID_STRING_OVERCURRENT_CHARGE_MOL
Definition: diag_cfg.h:219
@ DIAG_ID_MAX
Definition: diag_cfg.h:252
@ DIAG_ID_PACK_OVERCURRENT_DISCHARGE_MSL
Definition: diag_cfg.h:224
@ DIAG_ID_CURRENT_ON_OPEN_STRING
Definition: diag_cfg.h:225
@ DIAG_ID_STRING_OVERCURRENT_DISCHARGE_MSL
Definition: diag_cfg.h:220
@ DIAG_ID_OVERCURRENT_CHARGE_CELL_MSL
Definition: diag_cfg.h:211
@ DIAG_ID_OVERCURRENT_DISCHARGE_CELL_MOL
Definition: diag_cfg.h:216
@ DIAG_ID_CURRENT_MEASUREMENT_ERROR
Definition: diag_cfg.h:240
@ DIAG_ID_OVERCURRENT_CHARGE_CELL_MOL
Definition: diag_cfg.h:213
@ DIAG_ID_OVERCURRENT_DISCHARGE_CELL_RSL
Definition: diag_cfg.h:215
#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 currentOnOpenString[BS_NR_OF_STRINGS]
Definition: database_cfg.h:373
uint8_t currentMeasurementError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:346
uint8_t currentMeasurementTimeout[BS_NR_OF_STRINGS]
Definition: database_cfg.h:345
uint8_t cellChargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:489
uint8_t cellDischargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:491
uint8_t stringChargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:490
uint8_t stringDischargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:492
uint8_t stringChargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:450
uint8_t cellChargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:449
uint8_t stringDischargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:452
uint8_t cellDischargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:451
uint8_t packDischargeOvercurrent
Definition: database_cfg.h:442
uint8_t cellDischargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:471
uint8_t stringChargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:470
uint8_t cellChargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:469
uint8_t stringDischargeOvercurrent[BS_NR_OF_STRINGS]
Definition: database_cfg.h:472
DATA_BLOCK_MOL_FLAG_s * pTableMol
Definition: diag_cfg.h:165
DATA_BLOCK_RSL_FLAG_s * pTableRsl
Definition: diag_cfg.h:166
DATA_BLOCK_ERRORSTATE_s * pTableError
Definition: diag_cfg.h:164
DATA_BLOCK_MSL_FLAG_s * pTableMsl
Definition: diag_cfg.h:167