foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
diag_cbs_voltage.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_voltage.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 ================================*/
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->pTableMsl->overVoltage[stringNumber] = 0;
85  }
86  if (event == DIAG_EVENT_NOT_OK) {
87  kpkDiagShim->pTableMsl->overVoltage[stringNumber] = 1;
88  }
89  } else if (diagId == DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_RSL) {
90  if (event == DIAG_EVENT_RESET) {
91  kpkDiagShim->pTableRsl->overVoltage[stringNumber] = 0;
92  }
93  if (event == DIAG_EVENT_NOT_OK) {
94  kpkDiagShim->pTableRsl->overVoltage[stringNumber] = 1;
95  }
96  } else if (diagId == DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_MOL) {
97  if (event == DIAG_EVENT_RESET) {
98  kpkDiagShim->pTableMol->overVoltage[stringNumber] = 0;
99  }
100  if (event == DIAG_EVENT_NOT_OK) {
101  kpkDiagShim->pTableMol->overVoltage[stringNumber] = 1;
102  }
103  }
104 }
105 
107  DIAG_ID_e diagId,
108  DIAG_EVENT_e event,
109  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
110  uint32_t stringNumber) {
111  FAS_ASSERT(diagId < DIAG_ID_MAX);
112  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
113  FAS_ASSERT(kpkDiagShim != NULL_PTR);
114  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
115 
117  if (event == DIAG_EVENT_RESET) {
118  kpkDiagShim->pTableMsl->underVoltage[stringNumber] = 0;
119  }
120  if (event == DIAG_EVENT_NOT_OK) {
121  kpkDiagShim->pTableMsl->underVoltage[stringNumber] = 1;
122  }
123  } else if (diagId == DIAG_ID_CELL_VOLTAGE_UNDERVOLTAGE_RSL) {
124  if (event == DIAG_EVENT_RESET) {
125  kpkDiagShim->pTableRsl->underVoltage[stringNumber] = 0;
126  }
127  if (event == DIAG_EVENT_NOT_OK) {
128  kpkDiagShim->pTableRsl->underVoltage[stringNumber] = 1;
129  }
130  } else if (diagId == DIAG_ID_CELL_VOLTAGE_UNDERVOLTAGE_MOL) {
131  if (event == DIAG_EVENT_RESET) {
132  kpkDiagShim->pTableMol->underVoltage[stringNumber] = 0;
133  }
134  if (event == DIAG_EVENT_NOT_OK) {
135  kpkDiagShim->pTableMol->underVoltage[stringNumber] = 1;
136  }
137  }
138 }
139 
141  DIAG_ID_e diagId,
142  DIAG_EVENT_e event,
143  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
144  uint32_t stringNumber) {
145  FAS_ASSERT(
149  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
150  FAS_ASSERT(kpkDiagShim != NULL_PTR);
151  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
152 
153  switch (diagId) {
155  if (event == DIAG_EVENT_RESET) {
156  kpkDiagShim->pTableError->currentSensorVoltage1TimeoutError[stringNumber] = false;
157  } else if (event == DIAG_EVENT_NOT_OK) {
158  kpkDiagShim->pTableError->currentSensorVoltage1TimeoutError[stringNumber] = true;
159  } else {
160  /* no relevant event, do nothing */
161  }
162  break;
164  if (event == DIAG_EVENT_RESET) {
165  kpkDiagShim->pTableError->currentSensorVoltage2TimeoutError[stringNumber] = false;
166  } else if (event == DIAG_EVENT_NOT_OK) {
167  kpkDiagShim->pTableError->currentSensorVoltage2TimeoutError[stringNumber] = true;
168  } else {
169  /* no relevant event, do nothing */
170  }
171  break;
173  if (event == DIAG_EVENT_RESET) {
174  kpkDiagShim->pTableError->currentSensorVoltage3TimeoutError[stringNumber] = false;
175  } else if (event == DIAG_EVENT_NOT_OK) {
176  kpkDiagShim->pTableError->currentSensorVoltage3TimeoutError[stringNumber] = true;
177  } else {
178  /* no relevant event, do nothing */
179  }
180  break;
181 
182  default:
184  break; /* LCOV_EXCL_LINE */
185  }
186 }
187 
188 /*========== Externalized Static Function Implementations (Unit Test) =======*/
189 #ifdef UNITY_UNIT_TEST
190 #endif
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
Diagnosis driver header.
void DIAG_ErrorUndervoltage(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for undervoltage events
void DIAG_ErrorOvervoltage(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for overvoltage events
void DIAG_ErrorHighVoltageMeasurement(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for current sensor related events
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_CELL_VOLTAGE_UNDERVOLTAGE_MSL
Definition: diag_cfg.h:199
@ DIAG_ID_CURRENT_SENSOR_V2_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:247
@ DIAG_ID_CELL_VOLTAGE_UNDERVOLTAGE_RSL
Definition: diag_cfg.h:200
@ DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_MSL
Definition: diag_cfg.h:196
@ DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_RSL
Definition: diag_cfg.h:197
@ DIAG_ID_MAX
Definition: diag_cfg.h:262
@ DIAG_ID_CURRENT_SENSOR_V1_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:246
@ DIAG_ID_CURRENT_SENSOR_V3_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:248
@ DIAG_ID_CELL_VOLTAGE_UNDERVOLTAGE_MOL
Definition: diag_cfg.h:201
@ DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_MOL
Definition: diag_cfg.h:198
#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 currentSensorVoltage2TimeoutError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:351
bool currentSensorVoltage3TimeoutError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:352
bool currentSensorVoltage1TimeoutError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:350
uint8_t underVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:499
uint8_t overVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:498
uint8_t underVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:459
uint8_t overVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:458
uint8_t underVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:479
uint8_t overVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:478
DATA_BLOCK_MOL_FLAG_s * pTableMol
Definition: diag_cfg.h:167
DATA_BLOCK_RSL_FLAG_s * pTableRsl
Definition: diag_cfg.h:168
DATA_BLOCK_MSL_FLAG_s * pTableMsl
Definition: diag_cfg.h:169
DATA_BLOCK_ERROR_STATE_s * pTableError
Definition: diag_cfg.h:166