foxBMS  1.0.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 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
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 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 #include "fram.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 ch_id,
71  DIAG_EVENT_e event,
72  const DIAG_DATABASE_SHIM_s *const kpkDiagShim,
73  uint32_t stringNumber) {
74  FAS_ASSERT(ch_id < 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  if (ch_id == DIAG_ID_DEEP_DISCHARGE_DETECTED) {
80  if (event == DIAG_EVENT_RESET) {
81  kpkDiagShim->pTableError->deepDischargeDetected[stringNumber] = 0;
82  fram_deepDischargeFlags.deepDischargeFlag[stringNumber] = false;
83  }
84  if (event == DIAG_EVENT_NOT_OK) {
85  kpkDiagShim->pTableError->deepDischargeDetected[stringNumber] = 1;
86  fram_deepDischargeFlags.deepDischargeFlag[stringNumber] = true;
87  }
89  }
90 }
91 
92 /*========== Externalized Static Function Implementations (Unit Test) =======*/
FRAM_DEEP_DISCHARGE_FLAG::deepDischargeFlag
bool deepDischargeFlag[BS_NR_OF_STRINGS]
Definition: fram_cfg.h:139
DIAG_DATABASE_SHIM
Definition: diag_cfg.h:113
DIAG_EVENT_OK
@ DIAG_EVENT_OK
Definition: diag_cfg.h:201
DIAG_EVENT_RESET
@ DIAG_EVENT_RESET
Definition: diag_cfg.h:203
FAS_ASSERT
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:237
DIAG_ID_e
enum DIAG_ID DIAG_ID_e
diag_cbs.h
Diagnosis driver header.
fram_deepDischargeFlags
FRAM_DEEP_DISCHARGE_FLAG_s fram_deepDischargeFlags
Definition: fram_cfg.c:76
FRAM_BLOCK_ID_DEEP_DISCHARGE_FLAG
@ FRAM_BLOCK_ID_DEEP_DISCHARGE_FLAG
Definition: fram_cfg.h:91
DIAG_ErrorDeepDischarge
void DIAG_ErrorDeepDischarge(DIAG_ID_e ch_id, DIAG_EVENT_e event, const DIAG_DATABASE_SHIM_s *const kpkDiagShim, uint32_t stringNumber)
diagnosis callback function for deep discharge events
Definition: diag_cbs_deep-discharge.c:69
DIAG_EVENT_NOT_OK
@ DIAG_EVENT_NOT_OK
Definition: diag_cfg.h:202
DIAG_EVENT_e
enum DIAG_EVENT DIAG_EVENT_e
FRAM_Write
STD_RETURN_TYPE_e FRAM_Write(FRAM_BLOCK_ID_e blockId)
Writes a variable to the FRAM.
Definition: fram.c:101
DATA_BLOCK_ERRORSTATE::deepDischargeDetected
uint8_t deepDischargeDetected[BS_NR_OF_STRINGS]
Definition: database_cfg.h:359
NULL_PTR
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:66
DIAG_DATABASE_SHIM::pTableError
DATA_BLOCK_ERRORSTATE_s * pTableError
Definition: diag_cfg.h:114
DIAG_ID_DEEP_DISCHARGE_DETECTED
@ DIAG_ID_DEEP_DISCHARGE_DETECTED
Definition: diag_cfg.h:175
BS_NR_OF_STRINGS
#define BS_NR_OF_STRINGS
Definition: battery_system_cfg.h:89
DIAG_ID_MAX
@ DIAG_ID_MAX
Definition: diag_cfg.h:196
fram.h
Header for the driver for the FRAM module.