foxBMS - Unit Tests  1.1.2
The foxBMS Unit Tests API Documentation
diag_cbs_voltage.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, 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 2021-02-17 (date of last update)
47  * @ingroup ENGINE
48  * @prefix DIAG
49  *
50  * @brief Diagnosis driver implementation
51  * @details TODO
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "diag_cbs.h"
56 
57 /*========== Macros and Definitions =========================================*/
58 
59 /*========== Static Constant and Variable Definitions =======================*/
60 
61 /*========== Extern Constant and Variable Definitions =======================*/
62 
63 /*========== Static Function Prototypes =====================================*/
64 
65 /*========== Static Function Implementations ================================*/
66 
67 /*========== Extern Function Implementations ================================*/
69  DIAG_ID_e ch_id,
70  DIAG_EVENT_e event,
71  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
72  uint32_t stringNumber) {
73  FAS_ASSERT(ch_id < DIAG_ID_MAX);
74  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
75  FAS_ASSERT(kpkDiagShim != NULL_PTR);
76  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
77 
79  if (event == DIAG_EVENT_RESET) {
80  kpkDiagShim->pTableMsl->overVoltage[stringNumber] = 0;
81  }
82  if (event == DIAG_EVENT_NOT_OK) {
83  kpkDiagShim->pTableMsl->overVoltage[stringNumber] = 1;
84  }
85  } else if (ch_id == DIAG_ID_CELLVOLTAGE_OVERVOLTAGE_RSL) {
86  if (event == DIAG_EVENT_RESET) {
87  kpkDiagShim->pTableRsl->overVoltage[stringNumber] = 0;
88  }
89  if (event == DIAG_EVENT_NOT_OK) {
90  kpkDiagShim->pTableRsl->overVoltage[stringNumber] = 1;
91  }
92  } else if (ch_id == DIAG_ID_CELLVOLTAGE_OVERVOLTAGE_MOL) {
93  if (event == DIAG_EVENT_RESET) {
94  kpkDiagShim->pTableMol->overVoltage[stringNumber] = 0;
95  }
96  if (event == DIAG_EVENT_NOT_OK) {
97  kpkDiagShim->pTableMol->overVoltage[stringNumber] = 1;
98  }
99  }
100 }
101 
103  DIAG_ID_e ch_id,
104  DIAG_EVENT_e event,
105  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
106  uint32_t stringNumber) {
107  FAS_ASSERT(ch_id < DIAG_ID_MAX);
108  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
109  FAS_ASSERT(kpkDiagShim != NULL_PTR);
110  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
111 
113  if (event == DIAG_EVENT_RESET) {
114  kpkDiagShim->pTableMsl->underVoltage[stringNumber] = 0;
115  }
116  if (event == DIAG_EVENT_NOT_OK) {
117  kpkDiagShim->pTableMsl->underVoltage[stringNumber] = 1;
118  }
119  } else if (ch_id == DIAG_ID_CELLVOLTAGE_UNDERVOLTAGE_RSL) {
120  if (event == DIAG_EVENT_RESET) {
121  kpkDiagShim->pTableRsl->underVoltage[stringNumber] = 0;
122  }
123  if (event == DIAG_EVENT_NOT_OK) {
124  kpkDiagShim->pTableRsl->underVoltage[stringNumber] = 1;
125  }
126  } else if (ch_id == DIAG_ID_CELLVOLTAGE_UNDERVOLTAGE_MOL) {
127  if (event == DIAG_EVENT_RESET) {
128  kpkDiagShim->pTableMol->underVoltage[stringNumber] = 0;
129  }
130  if (event == DIAG_EVENT_NOT_OK) {
131  kpkDiagShim->pTableMol->underVoltage[stringNumber] = 1;
132  }
133  }
134 }
135 
137  DIAG_ID_e ch_id,
138  DIAG_EVENT_e event,
139  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
140  uint32_t stringNumber) {
141  FAS_ASSERT(ch_id < DIAG_ID_MAX);
142  FAS_ASSERT((event == DIAG_EVENT_OK) || (event == DIAG_EVENT_NOT_OK) || (event == DIAG_EVENT_RESET));
143  FAS_ASSERT(kpkDiagShim != NULL_PTR);
144  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
145 
146  switch (ch_id) {
148  if (event == DIAG_EVENT_RESET) {
149  kpkDiagShim->pTableError->currentSensorTimeoutV1[stringNumber] = 0u;
150  } else if (event == DIAG_EVENT_NOT_OK) {
151  kpkDiagShim->pTableError->currentSensorTimeoutV1[stringNumber] = 1u;
152  } else {
153  /* no relevant event, do nothing */
154  }
155  break;
157  if (event == DIAG_EVENT_RESET) {
158  kpkDiagShim->pTableError->currentSensorTimeoutV3[stringNumber] = 0u;
159  } else if (event == DIAG_EVENT_NOT_OK) {
160  kpkDiagShim->pTableError->currentSensorTimeoutV3[stringNumber] = 1u;
161  } else {
162  /* no relevant event, do nothing */
163  }
164  break;
165 
166  default:
168  break;
169  }
170 }
171 
172 /*========== Externalized Static Function Implementations (Unit Test) =======*/
#define BS_NR_OF_STRINGS
Diagnosis driver header.
void DIAG_ErrorUndervoltage(DIAG_ID_e ch_id, 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 ch_id, 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 ch_id, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for current sensor related events
enum DIAG_EVENT DIAG_EVENT_e
@ DIAG_EVENT_RESET
Definition: diag_cfg.h:236
@ DIAG_EVENT_NOT_OK
Definition: diag_cfg.h:235
@ DIAG_EVENT_OK
Definition: diag_cfg.h:234
enum DIAG_ID DIAG_ID_e
@ DIAG_ID_CELLVOLTAGE_UNDERVOLTAGE_RSL
Definition: diag_cfg.h:179
@ DIAG_ID_CELLVOLTAGE_OVERVOLTAGE_MOL
Definition: diag_cfg.h:177
@ DIAG_ID_CELLVOLTAGE_OVERVOLTAGE_RSL
Definition: diag_cfg.h:176
@ DIAG_ID_MAX
Definition: diag_cfg.h:229
@ DIAG_ID_CURRENT_SENSOR_V1_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:222
@ DIAG_ID_CURRENT_SENSOR_V3_MEASUREMENT_TIMEOUT
Definition: diag_cfg.h:223
@ DIAG_ID_CELLVOLTAGE_UNDERVOLTAGE_MOL
Definition: diag_cfg.h:180
@ DIAG_ID_CELLVOLTAGE_OVERVOLTAGE_MSL
Definition: diag_cfg.h:175
@ DIAG_ID_CELLVOLTAGE_UNDERVOLTAGE_MSL
Definition: diag_cfg.h:178
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:233
#define FAS_TRAP
Define that evaluates to essential boolean false thus tripping an assert.
Definition: fassert.h:108
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:66
uint8_t currentSensorTimeoutV3[BS_NR_OF_STRINGS]
Definition: database_cfg.h:345
uint8_t currentSensorTimeoutV1[BS_NR_OF_STRINGS]
Definition: database_cfg.h:344
uint8_t underVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:475
uint8_t overVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:474
uint8_t underVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:435
uint8_t overVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:434
uint8_t overVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:454
uint8_t underVoltage[BS_NR_OF_STRINGS]
Definition: database_cfg.h:455
DATA_BLOCK_MSL_FLAG_s * pTableMsl
Definition: diag_cfg.h:149
DATA_BLOCK_RSL_FLAG_s * pTableRsl
Definition: diag_cfg.h:148
DATA_BLOCK_ERRORSTATE_s * pTableError
Definition: diag_cfg.h:146
DATA_BLOCK_MOL_FLAG_s * pTableMol
Definition: diag_cfg.h:147