foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
sys_mon_cfg.h
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 sys_mon_cfg.h
44  * @author foxBMS Team
45  * @date 2019-11-28 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
48  * @ingroup ENGINE_CONFIGURATION
49  * @prefix SYSM
50  *
51  * @brief configuration of the system monitoring module
52  */
53 
54 #ifndef FOXBMS__SYS_MON_CFG_H_
55 #define FOXBMS__SYS_MON_CFG_H_
56 
57 /*========== Includes =======================================================*/
58 #include "general.h"
59 
60 #include "diag_cfg.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 /** diagnosis handling type for system monitoring */
64 typedef enum {
65  SYSM_HANDLING_DO_NOTHING, /*!< take no action */
66  SYSM_HANDLING_SWITCH_OFF_CONTACTOR /*!< open contactors */
68 
69 /**
70  * listing of system-relevant tasks or functions which are checked by
71  * the system monitoring
72  */
73 typedef enum {
74  SYSM_TASK_ID_ENGINE, /**< diag entry for engine task */
75  SYSM_TASK_ID_CYCLIC_1ms, /**< diag entry for engine cyclic 1ms task */
76  SYSM_TASK_ID_CYCLIC_10ms, /**< diag entry for engine cyclic 10ms task */
77  SYSM_TASK_ID_CYCLIC_100ms, /**< diag entry for engine cyclic 100ms task */
78  SYSM_TASK_ID_CYCLIC_ALGORITHM_100ms, /**< diag entry for algorithm cyclic 100ms task */
79  SYSM_TASK_ID_MAX /**< end marker do not delete */
81 
82 /** recording activation */
83 typedef enum {
84  SYSM_RECORDING_ENABLED, /*!< enable event recording */
85  SYSM_RECORDING_DISABLED, /*!< disable event recording */
87 
88 /** enable diagnosis entry for system monitoring */
89 typedef enum {
90  SYSM_ENABLED, /*!< entry enabled */
91  SYSM_DISABLED, /*!< entry disabled */
93 
94 /** Channel configuration of one system monitoring channel */
95 typedef struct {
96  SYSM_TASK_ID_e id; /*!< the task id by its symbolic name */
97  SYSM_ACTIVATE_e enable; /*!< enable or disable system monitoring */
98  uint8_t cycleTime; /*!< max. delay time in ms until #SYSM_Notify has to be called */
99  uint8_t maxJitter; /*!< max. jitter in ms */
100  SYSM_RECORDING_e enableRecording; /*!< enabled if set to DIAG_RECORDING_ENABLED */
101  SYSM_HANDLING_TYPE_e handlingType; /*!< type of handling of system monitoring errors */
102  void (*callbackFunction)(SYSM_TASK_ID_e taskId); /*!< callback in case of error */
104 
105 /*========== Extern Constant and Variable Declarations ======================*/
106 /** diag system monitoring struct */
108 
109 /*========== Extern Function Prototypes =====================================*/
110 
111 /*========== Externalized Static Function Implementations (Unit Test) =======*/
112 #ifdef UNITY_UNIT_TEST
113 extern void TEST_SYSM_DummyCallback(SYSM_TASK_ID_e taskId);
114 #endif
115 
116 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
117 
118 #endif /* FOXBMS__SYS_MON_CFG_H_ */
Diagnostic module configuration header.
General macros and definitions for the whole platform.
SYSM_RECORDING_e enableRecording
Definition: sys_mon_cfg.h:100
SYSM_HANDLING_TYPE_e handlingType
Definition: sys_mon_cfg.h:101
SYSM_ACTIVATE_e enable
Definition: sys_mon_cfg.h:97
SYSM_TASK_ID_e id
Definition: sys_mon_cfg.h:96
SYSM_RECORDING_e
Definition: sys_mon_cfg.h:83
@ SYSM_RECORDING_ENABLED
Definition: sys_mon_cfg.h:84
@ SYSM_RECORDING_DISABLED
Definition: sys_mon_cfg.h:85
SYSM_HANDLING_TYPE_e
Definition: sys_mon_cfg.h:64
@ SYSM_HANDLING_DO_NOTHING
Definition: sys_mon_cfg.h:65
@ SYSM_HANDLING_SWITCH_OFF_CONTACTOR
Definition: sys_mon_cfg.h:66
SYSM_MONITORING_CFG_s sysm_ch_cfg[]
Definition: sys_mon_cfg.c:70
SYSM_ACTIVATE_e
Definition: sys_mon_cfg.h:89
@ SYSM_ENABLED
Definition: sys_mon_cfg.h:90
@ SYSM_DISABLED
Definition: sys_mon_cfg.h:91
SYSM_TASK_ID_e
Definition: sys_mon_cfg.h:73
@ SYSM_TASK_ID_CYCLIC_10ms
Definition: sys_mon_cfg.h:76
@ SYSM_TASK_ID_MAX
Definition: sys_mon_cfg.h:79
@ SYSM_TASK_ID_CYCLIC_ALGORITHM_100ms
Definition: sys_mon_cfg.h:78
@ SYSM_TASK_ID_CYCLIC_100ms
Definition: sys_mon_cfg.h:77
@ SYSM_TASK_ID_CYCLIC_1ms
Definition: sys_mon_cfg.h:75
@ SYSM_TASK_ID_ENGINE
Definition: sys_mon_cfg.h:74