foxBMS - Unit Tests  1.1.2
The foxBMS Unit Tests API Documentation
sys_mon_cfg.h
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 sys_mon_cfg.h
44  * @author foxBMS Team
45  * @date 2019-11-28 (date of creation)
46  * @updated 2020-01-21 (date of last update)
47  * @ingroup ENGINE_CONFIGURATION
48  * @prefix SYSM
49  *
50  * @brief TODO
51  */
52 
53 #ifndef FOXBMS__SYS_MON_CFG_H_
54 #define FOXBMS__SYS_MON_CFG_H_
55 
56 /*========== Includes =======================================================*/
57 #include "general.h"
58 
59 #include "diag_cfg.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 /** diagnosis handling type for system monitoring */
63 typedef enum SYSM_HANDLING_TYPE {
67 
68 /**
69  * listing of system-relevant tasks or functions which are checked by
70  * the system monitoring
71  */
72 typedef enum SYSM_TASK_ID {
73  SYSM_TASK_ID_ENGINE, /**< diag entry for engine task */
74  SYSM_TASK_ID_CYCLIC_1ms, /**< diag entry for engine cyclic 1ms task */
75  SYSM_TASK_ID_CYCLIC_10ms, /**< diag entry for engine cyclic 10ms task */
76  SYSM_TASK_ID_CYCLIC_100ms, /**< diag entry for engine cyclic 100ms task */
77  SYSM_TASK_ID_CYCLIC_ALGORITHM_100ms, /**< diag entry for algorithm cyclic 100ms task */
78  SYSM_TASK_ID_MAX /**< end marker do not delete */
80 
81 /** recording activation */
82 typedef enum SYSM_RECORDING {
83  SYSM_RECORDING_ENABLED, /*!< enable event recording */
84  SYSM_RECORDING_DISABLED, /*!< disable event recording */
86 
87 /** enable diagnosis entry for system monitoring */
88 typedef enum SYSM_ACTIVATE {
89  SYSM_ENABLED, /**< TODO */
90  SYSM_DISABLED, /**< TODO */
92 
93 /** Channel configuration of one system monitoring channel */
94 typedef struct SYSM_CH_CFG {
95  SYSM_TASK_ID_e id; /**< the task id by its symbolic name */
96  SYSM_ACTIVATE_e enable; /**< enable or disable system monitoring */
97  uint8_t cycleTime; /**< max. delay time in ms until #SYSM_Notify has to be called */
98  uint8_t maxJitter; /**< max. jitter in ms */
99  SYSM_RECORDING_e enableRecording; /**< enabled if set to DIAG_RECORDING_ENABLED */
100  SYSM_HANDLING_TYPE_e handlingType; /**< type of handling of system monitoring errors */
101  void (*callbackfunc)(SYSM_TASK_ID_e); /**< callback in case of error */
103 
104 /*========== Extern Constant and Variable Declarations ======================*/
105 /** diag system monitoring struct */
107 
108 /*========== Extern Function Prototypes =====================================*/
109 /**
110  * @brief initialization function for system monitoring
111  * @details Has to be called once after startup to initialize and check system
112  * monitoring related functionality
113  * @return #STD_OK if no configuration error detected, otherwise #STD_NOT_OK
114  */
115 extern STD_RETURN_TYPE_e SYSM_Init(void);
116 
117 /*========== Externalized Static Function Implementations (Unit Test) =======*/
118 #ifdef UNITY_UNIT_TEST
119 extern void TEST_SYSM_DummyCallback(SYSM_TASK_ID_e tsk_id);
120 #endif
121 
122 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
123 
124 #endif /* FOXBMS__SYS_MON_CFG_H_ */
Diagnostic module configuration header.
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
General macros and definitions for the whole platform.
SYSM_HANDLING_TYPE_e handlingType
Definition: sys_mon_cfg.h:100
SYSM_ACTIVATE_e enable
Definition: sys_mon_cfg.h:96
SYSM_TASK_ID_e id
Definition: sys_mon_cfg.h:95
uint8_t maxJitter
Definition: sys_mon_cfg.h:98
void(* callbackfunc)(SYSM_TASK_ID_e)
Definition: sys_mon_cfg.h:101
SYSM_RECORDING_e enableRecording
Definition: sys_mon_cfg.h:99
uint8_t cycleTime
Definition: sys_mon_cfg.h:97
struct SYSM_CH_CFG SYSM_MONITORING_CFG_s
enum SYSM_RECORDING SYSM_RECORDING_e
void TEST_SYSM_DummyCallback(SYSM_TASK_ID_e tsk_id)
Definition: sys_mon_cfg.c:128
enum SYSM_HANDLING_TYPE SYSM_HANDLING_TYPE_e
STD_RETURN_TYPE_e SYSM_Init(void)
initialization function for system monitoring
Definition: sys_mon_cfg.c:117
SYSM_HANDLING_TYPE
Definition: sys_mon_cfg.h:63
@ SYSM_HANDLING_SWITCHOFFCONTACTOR
Definition: sys_mon_cfg.h:65
@ SYSM_HANDLING_DONOTHING
Definition: sys_mon_cfg.h:64
SYSM_ACTIVATE
Definition: sys_mon_cfg.h:88
@ SYSM_ENABLED
Definition: sys_mon_cfg.h:89
@ SYSM_DISABLED
Definition: sys_mon_cfg.h:90
SYSM_TASK_ID
Definition: sys_mon_cfg.h:72
@ SYSM_TASK_ID_CYCLIC_10ms
Definition: sys_mon_cfg.h:75
@ SYSM_TASK_ID_MAX
Definition: sys_mon_cfg.h:78
@ SYSM_TASK_ID_CYCLIC_ALGORITHM_100ms
Definition: sys_mon_cfg.h:77
@ SYSM_TASK_ID_CYCLIC_100ms
Definition: sys_mon_cfg.h:76
@ SYSM_TASK_ID_CYCLIC_1ms
Definition: sys_mon_cfg.h:74
@ SYSM_TASK_ID_ENGINE
Definition: sys_mon_cfg.h:73
SYSM_RECORDING
Definition: sys_mon_cfg.h:82
@ SYSM_RECORDING_ENABLED
Definition: sys_mon_cfg.h:83
@ SYSM_RECORDING_DISABLED
Definition: sys_mon_cfg.h:84
SYSM_MONITORING_CFG_s sysm_ch_cfg[]
Definition: sys_mon_cfg.c:66
enum SYSM_TASK_ID SYSM_TASK_ID_e
enum SYSM_ACTIVATE SYSM_ACTIVATE_e