foxBMS-UnitTests  1.0.0
The foxBMS Unit Tests API Documentation
sys_mon_cfg.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 sys_mon_cfg.c
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 /*========== Includes =======================================================*/
54 #include "sys_mon_cfg.h"
55 
56 #include "ftask_cfg.h"
57 
58 /*========== Macros and Definitions =========================================*/
59 
60 /*========== Static Constant and Variable Definitions =======================*/
61 
62 /*========== Static Function Prototypes =====================================*/
63 static void SYSM_DummyCallback(SYSM_TASK_ID_e tsk_id);
64 
65 /*========== Extern Constant and Variable Definitions =======================*/
102 };
103 
104 /*========== Static Function Implementations ================================*/
105 /**
106  * @brief dummy callback function of system monitoring error events
107  */
109  /* Dummy function -> empty */
110 }
111 
112 /*========== Extern Function Implementations ================================*/
114  STD_RETURN_TYPE_e retval = STD_OK;
115  if ((sizeof(sysm_ch_cfg) / sizeof(SYSM_MONITORING_CFG_s)) != (unsigned long)SYSM_TASK_ID_MAX) {
116  /* Configuration error - invalid configuration of task/modules */
117  retval = STD_NOT_OK;
118  }
119  return retval;
120 }
121 
122 /*========== Externalized Static Function Implementations (Unit Test) =======*/
123 #ifdef UNITY_UNIT_TEST
125  return SYSM_DummyCallback(tsk_id);
126 }
127 #endif
FTSK_TSK_CYCLIC_1MS_CYCLE_TIME
#define FTSK_TSK_CYCLIC_1MS_CYCLE_TIME
Cycle time of 1ms task.
Definition: ftask_cfg.h:82
FTSK_TSK_CYCLIC_100MS_MAXIMUM_JITTER
#define FTSK_TSK_CYCLIC_100MS_MAXIMUM_JITTER
Maximum allowed jitter of 100ms task.
Definition: ftask_cfg.h:109
FTSK_TSK_CYCLIC_ALGORITHM_100MS_MAXIMUM_JITTER
#define FTSK_TSK_CYCLIC_ALGORITHM_100MS_MAXIMUM_JITTER
Maximum allowed jitter of 100ms task for algorithms.
Definition: ftask_cfg.h:121
SYSM_TASK_ID_MAX
@ SYSM_TASK_ID_MAX
Definition: sys_mon_cfg.h:78
STD_RETURN_TYPE_e
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
SYSM_CH_CFG
Definition: sys_mon_cfg.h:94
SYSM_DummyCallback
static void SYSM_DummyCallback(SYSM_TASK_ID_e tsk_id)
dummy callback function of system monitoring error events
Definition: sys_mon_cfg.c:108
sysm_ch_cfg
SYSM_MONITORING_CFG_s sysm_ch_cfg[]
Definition: sys_mon_cfg.c:66
TEST_SYSM_DummyCallback
void TEST_SYSM_DummyCallback(SYSM_TASK_ID_e tsk_id)
Definition: sys_mon_cfg.c:124
FTSK_TSK_CYCLIC_10MS_MAXIMUM_JITTER
#define FTSK_TSK_CYCLIC_10MS_MAXIMUM_JITTER
Maximum allowed jitter of 10ms task.
Definition: ftask_cfg.h:97
SYSM_TASK_ID_e
enum SYSM_TASK_ID SYSM_TASK_ID_e
SYSM_HANDLING_SWITCHOFFCONTACTOR
@ SYSM_HANDLING_SWITCHOFFCONTACTOR
Definition: sys_mon_cfg.h:65
ftask_cfg.h
Task configuration header.
FTSK_TSK_ENGINE_MAXIMUM_JITTER
#define FTSK_TSK_ENGINE_MAXIMUM_JITTER
Maximum allowed jitter of engine task.
Definition: ftask_cfg.h:73
FTSK_TSK_CYCLIC_10MS_CYCLE_TIME
#define FTSK_TSK_CYCLIC_10MS_CYCLE_TIME
Cycle time of 10 ms task.
Definition: ftask_cfg.h:94
SYSM_TASK_ID_CYCLIC_100ms
@ SYSM_TASK_ID_CYCLIC_100ms
Definition: sys_mon_cfg.h:76
STD_OK
@ STD_OK
Definition: fstd_types.h:72
FTSK_TSK_CYCLIC_ALGORITHM_100MS_CYCLE_TIME
#define FTSK_TSK_CYCLIC_ALGORITHM_100MS_CYCLE_TIME
Cycle time of 100ms task for algorithms.
Definition: ftask_cfg.h:118
SYSM_TASK_ID_CYCLIC_10ms
@ SYSM_TASK_ID_CYCLIC_10ms
Definition: sys_mon_cfg.h:75
STD_NOT_OK
@ STD_NOT_OK
Definition: fstd_types.h:73
SYSM_TASK_ID_ENGINE
@ SYSM_TASK_ID_ENGINE
Definition: sys_mon_cfg.h:73
FTSK_TSK_CYCLIC_1MS_MAXIMUM_JITTER
#define FTSK_TSK_CYCLIC_1MS_MAXIMUM_JITTER
Maximum allowed jitter of 1ms task.
Definition: ftask_cfg.h:85
FTSK_TSK_ENGINE_CYCLE_TIME
#define FTSK_TSK_ENGINE_CYCLE_TIME
Cycle time of engine task.
Definition: ftask_cfg.h:70
FTSK_TSK_CYCLIC_100MS_CYCLE_TIME
#define FTSK_TSK_CYCLIC_100MS_CYCLE_TIME
Cycle time of 100ms task.
Definition: ftask_cfg.h:106
SYSM_TASK_ID_CYCLIC_1ms
@ SYSM_TASK_ID_CYCLIC_1ms
Definition: sys_mon_cfg.h:74
SYSM_RECORDING_ENABLED
@ SYSM_RECORDING_ENABLED
Definition: sys_mon_cfg.h:83
SYSM_ENABLED
@ SYSM_ENABLED
Definition: sys_mon_cfg.h:89
sys_mon_cfg.h
TODO.
SYSM_Init
STD_RETURN_TYPE_e SYSM_Init(void)
initialization function for system monitoring
Definition: sys_mon_cfg.c:113
SYSM_TASK_ID_CYCLIC_ALGORITHM_100ms
@ SYSM_TASK_ID_CYCLIC_ALGORITHM_100ms
Definition: sys_mon_cfg.h:77