foxBMS  1.5.0
The foxBMS Battery Management System API Documentation
diag_cbs_deep-discharge.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_deep-discharge.c
44  * @author foxBMS Team
45  * @date 2021-02-17 (date of creation)
46  * @updated 2023-02-03 (date of last update)
47  * @version v1.5.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 "fram.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 
82  if (diagId == DIAG_ID_DEEP_DISCHARGE_DETECTED) {
83  if (event == DIAG_EVENT_RESET) {
84  kpkDiagShim->pTableError->deepDischargeDetectedError[stringNumber] = false;
85  fram_deepDischargeFlags.deepDischargeFlag[stringNumber] = false;
86  }
87  if (event == DIAG_EVENT_NOT_OK) {
88  kpkDiagShim->pTableError->deepDischargeDetectedError[stringNumber] = true;
89  fram_deepDischargeFlags.deepDischargeFlag[stringNumber] = true;
90  }
92  }
93 }
94 
95 /*========== Externalized Static Function Implementations (Unit Test) =======*/
96 #ifdef UNITY_UNIT_TEST
97 #endif
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
Diagnosis driver header.
void DIAG_ErrorDeepDischarge(DIAG_ID_e diagId, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for deep discharge events
DIAG_EVENT_e
Definition: diag_cfg.h:264
@ DIAG_EVENT_RESET
Definition: diag_cfg.h:267
@ DIAG_EVENT_NOT_OK
Definition: diag_cfg.h:266
@ DIAG_EVENT_OK
Definition: diag_cfg.h:265
DIAG_ID_e
Definition: diag_cfg.h:176
@ DIAG_ID_MAX
Definition: diag_cfg.h:260
@ DIAG_ID_DEEP_DISCHARGE_DETECTED
Definition: diag_cfg.h:228
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:254
FRAM_RETURN_TYPE_e FRAM_WriteData(FRAM_BLOCK_ID_e blockId)
Writes a variable to the FRAM.
Definition: fram.c:133
Header for the driver for the FRAM module.
FRAM_DEEP_DISCHARGE_FLAG_s fram_deepDischargeFlags
Definition: fram_cfg.c:77
@ FRAM_BLOCK_ID_DEEP_DISCHARGE_FLAG
Definition: fram_cfg.h:108
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:77
bool deepDischargeDetectedError[BS_NR_OF_STRINGS]
Definition: database_cfg.h:375
DATA_BLOCK_ERROR_STATE_s * pTableError
Definition: diag_cfg.h:166
bool deepDischargeFlag[BS_NR_OF_STRINGS]
Definition: fram_cfg.h:159