foxBMS  1.3.0
The foxBMS Battery Management System API Documentation
sys_mon_cfg.c
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.c
44  * @author foxBMS Team
45  * @date 2019-11-28 (date of creation)
46  * @updated 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup ENGINE_CONFIGURATION
49  * @prefix SYSM
50  *
51  * @brief configuration of the system monitoring module
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "sys_mon_cfg.h"
56 
57 #include "ftask_cfg.h"
58 
59 #include "fram.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Static Constant and Variable Definitions =======================*/
64 
65 /*========== Static Function Prototypes =====================================*/
66 static void SYSM_DummyCallback(SYSM_TASK_ID_e taskId);
67 
68 /*========== Extern Constant and Variable Definitions =======================*/
69 /* DOCUMENTATION marker - sys_mon config entry */
100  SYSM_ENABLED,
106 };
107 /* DOCUMENTATION marker - sys_mon config exit */
108 
110  (sizeof(sysm_ch_cfg) / sizeof(SYSM_MONITORING_CFG_s)) == (uint32_t)SYSM_TASK_ID_MAX,
111  "invalid sys_mon configuration!");
112 
113 /*========== Static Function Implementations ================================*/
114 /**
115  * @brief dummy callback function of system monitoring error events
116  */
117 static void SYSM_DummyCallback(SYSM_TASK_ID_e taskId) {
118  /* this is a dummy implementation and not using the argument here is fine */
119  (void)taskId;
120  /* Dummy function therefore it is empty */
121 }
122 
123 /*========== Extern Function Implementations ================================*/
124 
125 /*========== Externalized Static Function Implementations (Unit Test) =======*/
126 #ifdef UNITY_UNIT_TEST
127 void TEST_SYSM_DummyCallback(SYSM_TASK_ID_e taskId) {
128  return SYSM_DummyCallback(taskId);
129 }
130 #endif
Header for the driver for the FRAM module.
Task configuration header.
#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_MAXIMUM_JITTER
Maximum allowed jitter of 100ms task for algorithms.
Definition: ftask_cfg.h:149
#define FTSK_TASK_ENGINE_MAXIMUM_JITTER
Maximum allowed jitter of engine task.
Definition: ftask_cfg.h:77
#define FTSK_TASK_CYCLIC_1MS_CYCLE_TIME
Cycle time of 1ms task.
Definition: ftask_cfg.h:92
#define FTSK_TASK_CYCLIC_100MS_MAXIMUM_JITTER
Maximum allowed jitter of 100ms task.
Definition: ftask_cfg.h:131
#define FTSK_TASK_ENGINE_CYCLE_TIME
Cycle time of engine task.
Definition: ftask_cfg.h:74
#define FTSK_TASK_CYCLIC_ALGORITHM_100MS_CYCLE_TIME
Cycle time of 100ms task for algorithms.
Definition: ftask_cfg.h:146
#define FTSK_TASK_CYCLIC_10MS_CYCLE_TIME
Cycle time of 10 ms task.
Definition: ftask_cfg.h:110
#define FTSK_TASK_CYCLIC_10MS_MAXIMUM_JITTER
Maximum allowed jitter of 10ms task.
Definition: ftask_cfg.h:113
#define FTSK_TASK_CYCLIC_100MS_CYCLE_TIME
Cycle time of 100ms task.
Definition: ftask_cfg.h:128
#define FTSK_TASK_CYCLIC_1MS_MAXIMUM_JITTER
Maximum allowed jitter of 1ms task.
Definition: ftask_cfg.h:95
f_static_assert((sizeof(sysm_ch_cfg)/sizeof(SYSM_MONITORING_CFG_s))==(uint32_t) SYSM_TASK_ID_MAX, "invalid sys_mon configuration!")
SYSM_MONITORING_CFG_s sysm_ch_cfg[]
Definition: sys_mon_cfg.c:70
static void SYSM_DummyCallback(SYSM_TASK_ID_e taskId)
dummy callback function of system monitoring error events
Definition: sys_mon_cfg.c:117
configuration of the system monitoring module
@ SYSM_RECORDING_ENABLED
Definition: sys_mon_cfg.h:84
@ SYSM_HANDLING_SWITCHOFFCONTACTOR
Definition: sys_mon_cfg.h:66
@ SYSM_ENABLED
Definition: sys_mon_cfg.h:90
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