foxBMS - Unit Tests  1.2.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 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.c
44  * @author foxBMS Team
45  * @date 2019-11-28 (date of creation)
46  * @updated 2021-07-23 (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  */
108 /* this is a dummy implementation and not using the argument here is fine */
109 #pragma diag_push
110 #pragma diag_suppress 880
112  /* Dummy function -> empty */
113 }
114 #pragma diag_pop
115 
116 /*========== Extern Function Implementations ================================*/
118  STD_RETURN_TYPE_e retval = STD_OK;
119  if ((sizeof(sysm_ch_cfg) / sizeof(SYSM_MONITORING_CFG_s)) != (unsigned long)SYSM_TASK_ID_MAX) {
120  /* Configuration error - invalid configuration of task/modules */
121  retval = STD_NOT_OK;
122  }
123  return retval;
124 }
125 
126 /*========== Externalized Static Function Implementations (Unit Test) =======*/
127 #ifdef UNITY_UNIT_TEST
129  return SYSM_DummyCallback(tsk_id);
130 }
131 #endif
@ STD_NOT_OK
Definition: fstd_types.h:73
@ STD_OK
Definition: fstd_types.h:72
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
Task configuration header.
#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_MAXIMUM_JITTER
Maximum allowed jitter of 100ms task for algorithms.
Definition: ftask_cfg.h:121
#define FTSK_TASK_ENGINE_MAXIMUM_JITTER
Maximum allowed jitter of engine task.
Definition: ftask_cfg.h:73
#define FTSK_TASK_CYCLIC_1MS_CYCLE_TIME
Cycle time of 1ms task.
Definition: ftask_cfg.h:82
#define FTSK_TASK_CYCLIC_100MS_MAXIMUM_JITTER
Maximum allowed jitter of 100ms task.
Definition: ftask_cfg.h:109
#define FTSK_TASK_ENGINE_CYCLE_TIME
Cycle time of engine task.
Definition: ftask_cfg.h:70
#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_CYCLE_TIME
Cycle time of 100ms task for algorithms.
Definition: ftask_cfg.h:118
#define FTSK_TASK_CYCLIC_10MS_CYCLE_TIME
Cycle time of 10 ms task.
Definition: ftask_cfg.h:94
#define FTSK_TASK_CYCLIC_10MS_MAXIMUM_JITTER
Maximum allowed jitter of 10ms task.
Definition: ftask_cfg.h:97
#define FTSK_TASK_CYCLIC_100MS_CYCLE_TIME
Cycle time of 100ms task.
Definition: ftask_cfg.h:106
#define FTSK_TASK_CYCLIC_1MS_MAXIMUM_JITTER
Maximum allowed jitter of 1ms task.
Definition: ftask_cfg.h:85
void TEST_SYSM_DummyCallback(SYSM_TASK_ID_e tsk_id)
Definition: sys_mon_cfg.c:128
static void SYSM_DummyCallback(SYSM_TASK_ID_e tsk_id)
dummy callback function of system monitoring error events
Definition: sys_mon_cfg.c:111
STD_RETURN_TYPE_e SYSM_Init(void)
initialization function for system monitoring
Definition: sys_mon_cfg.c:117
SYSM_MONITORING_CFG_s sysm_ch_cfg[]
Definition: sys_mon_cfg.c:66
@ SYSM_HANDLING_SWITCHOFFCONTACTOR
Definition: sys_mon_cfg.h:65
@ SYSM_ENABLED
Definition: sys_mon_cfg.h:89
@ 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_ENABLED
Definition: sys_mon_cfg.h:83
enum SYSM_TASK_ID SYSM_TASK_ID_e