foxBMS - Unit Tests  1.4.1
The foxBMS Unit Tests API Documentation
diag_cbs_voltage.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_voltage.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 
80  if (event == DIAG_EVENT_RESET) {
81  kpkDiagShim->pTableMsl->overVoltage[stringNumber] = 0;
82  }
83  if (event == DIAG_EVENT_NOT_OK) {
84  kpkDiagShim->pTableMsl->overVoltage[stringNumber] = 1;
85  }
86  } else if (diagId == DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_RSL) {
87  if (event == DIAG_EVENT_RESET) {
88  kpkDiagShim->pTableRsl->overVoltage[stringNumber] = 0;
89  }
90  if (event == DIAG_EVENT_NOT_OK) {
91  kpkDiagShim->pTableRsl->overVoltage[stringNumber] = 1;
92  }
93  } else if (diagId == DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_MOL) {
94  if (event == DIAG_EVENT_RESET) {
95  kpkDiagShim->pTableMol->overVoltage[stringNumber] = 0;
96  }
97  if (event == DIAG_EVENT_NOT_OK) {
98  kpkDiagShim->pTableMol->overVoltage[stringNumber] = 1;
99  }
100  }
101 }
102 
104  DIAG_ID_e diagId,
105  DIAG_EVENT_e event,
106  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
107  uint32_t stringNumber) {
108  FAS_ASSERT(diagId < DIAG_ID_MAX);
109  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
110  FAS_ASSERT(kpkDiagShim != NULL_PTR);
111  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
112 
114  if (event == DIAG_EVENT_RESET) {
115  kpkDiagShim->pTableMsl->underVoltage[stringNumber] = 0;
116  }
117  if (event == DIAG_EVENT_NOT_OK) {
118  kpkDiagShim->pTableMsl->underVoltage[stringNumber] = 1;
119  }
120  } else if (diagId == DIAG_ID_CELL_VOLTAGE_UNDERVOLTAGE_RSL) {
121  if (event == DIAG_EVENT_RESET) {
122  kpkDiagShim->pTableRsl->underVoltage[stringNumber] = 0;
123  }
124  if (event == DIAG_EVENT_NOT_OK) {
125  kpkDiagShim->pTableRsl->underVoltage[stringNumber] = 1;
126  }
127  } else if (diagId == DIAG_ID_CELL_VOLTAGE_UNDERVOLTAGE_MOL) {
128  if (event == DIAG_EVENT_RESET) {
129  kpkDiagShim->pTableMol->underVoltage[stringNumber] = 0;
130  }
131  if (event == DIAG_EVENT_NOT_OK) {
132  kpkDiagShim->pTableMol->underVoltage[stringNumber] = 1;
133  }
134  }
135 }
136 
138  DIAG_ID_e diagId,
139  DIAG_EVENT_e event,
140  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
141  uint32_t stringNumber) {
142  FAS_ASSERT(diagId < DIAG_ID_MAX);
143  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
144  FAS_ASSERT(kpkDiagShim != NULL_PTR);
145  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
146 
147  switch (diagId) {
149  if (event == DIAG_EVENT_RESET) {
150  kpkDiagShim->pTableError->currentSensorTimeoutV1[stringNumber] = 0u;
151  } else if (event == DIAG_EVENT_NOT_OK) {
152  kpkDiagShim->pTableError->currentSensorTimeoutV1[stringNumber] = 1u;
153  } else {
154  /* no relevant event, do nothing */
155  }
156  break;
158  if (event == DIAG_EVENT_RESET) {
159  kpkDiagShim->pTableError->currentSensorTimeoutV3[stringNumber] = 0u;
160  } else if (event == DIAG_EVENT_NOT_OK) {
161  kpkDiagShim->pTableError->currentSensorTimeoutV3[stringNumber] = 1u;
162  } else {
163  /* no relevant event, do nothing */
164  }
165  break;
166 
167  default:
169  break;
170  }
171 }
172 
173 /*========== Externalized Static Function Implementations (Unit Test) =======*/
#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: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_CELL_VOLTAGE_UNDERVOLTAGE_MSL
Definition: diag_cfg.h:196
@ DIAG_ID_CELL_VOLTAGE_UNDERVOLTAGE_RSL
Definition: diag_cfg.h:197
@ DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_MSL
Definition: diag_cfg.h:193
@ DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_RSL
Definition: diag_cfg.h:194
@ DIAG_ID_MAX
Definition: diag_cfg.h:252
@ DIAG_ID_CURRENT_SENSOR_V1_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:241
@ DIAG_ID_CURRENT_SENSOR_V3_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:242
@ DIAG_ID_CELL_VOLTAGE_UNDERVOLTAGE_MOL
Definition: diag_cfg.h:198
@ DIAG_ID_CELL_VOLTAGE_OVERVOLTAGE_MOL
Definition: diag_cfg.h:195
#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 currentSensorTimeoutV1[BS_NR_OF_STRINGS]
Definition: database_cfg.h:347
uint8_t currentSensorTimeoutV3[BS_NR_OF_STRINGS]
Definition: database_cfg.h:348
uint8_t underVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:484
uint8_t overVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:483
uint8_t underVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:444
uint8_t overVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:443
uint8_t underVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:464
uint8_t overVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:463
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