foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
sys_mon.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.h
44  * @author foxBMS Team
45  * @date 2019-11-28 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup ENGINE
49  * @prefix SYSM
50  *
51  * @brief system monitoring module
52  */
53 
54 #ifndef FOXBMS__SYS_MON_H_
55 #define FOXBMS__SYS_MON_H_
56 
57 /*========== Includes =======================================================*/
58 #include "sys_mon_cfg.h"
59 
60 #include "fram.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 /** defines entry or exit */
64 typedef enum {
65  SYSM_NOTIFY_ENTER, /**< entry into a task */
66  SYSM_NOTIFY_EXIT, /**< exit from a task */
68 
69 /** state (in summary) used for task or function notification */
70 typedef struct {
71  SYSM_NOTIFY_TYPE_e state; /**< state of the task */
72  uint32_t timestampEnter; /**< timestamp of entry into state */
73  uint32_t timestampExit; /**< timestamp of exit from state */
74  uint32_t duration; /**< duration between last complete entry and exit cycle */
76 
77 /** compact data fromat for reporting violation states */
78 typedef struct {
79  bool recordedViolationAny; /*!< compound flag indicating if any violation occurred */
80  bool recordedViolationEngine; /*!< flag indicating if a engine violation is recorded */
81  bool recordedViolation1ms; /*!< flag indicating if a 1ms violation is recorded */
82  bool recordedViolation10ms; /*!< flag indicating if a 10ms violation is recorded */
83  bool recordedViolation100ms; /*!< flag indicating if a 100ms violation is recorded */
84  bool recordedViolation100msAlgo; /*!< flag indicating if a 100ms algorithm violation is recorded */
86 
87 /*========== Extern Constant and Variable Declarations ======================*/
88 
89 /*========== Extern Function Prototypes =====================================*/
90 /**
91  * @brief initialization function for system monitoring
92  * @details Has to be called once after startup to initialize and check system
93  * monitoring related functionality
94  * @return #STD_OK if no configuration error detected, otherwise #STD_NOT_OK
95  */
96 extern STD_RETURN_TYPE_e SYSM_Init(void);
97 
98 /**
99  * @brief overall system monitoring
100  * @details checks notifications (state and timestamps) of all system-relevant
101  * tasks or functions all checks should be customized corresponding
102  * to its timing and state requirements
103  */
104 extern void SYSM_CheckNotifications(void);
105 
106 /**
107  * @brief Sets needed bits to indicate that a task is running
108  * @details Has to be called in every function using the system monitoring.
109  * @param taskId task id to notify system monitoring
110  * @param state whether function has been called at entry or exit
111  * @param timestamp time
112  */
113 extern void SYSM_Notify(SYSM_TASK_ID_e taskId, SYSM_NOTIFY_TYPE_e state, uint32_t timestamp);
114 
115 /**
116  * @brief Returns the timing violation flags determined from fram state
117  * @details This function reads the timing states and determines if a violation
118  * has occurred.
119  * @param[out] pAnswer pointer to a #SYSM_TIMING_VIOLATION_RESPONSE_s struct that will be filled by the function
120  */
122 
123 /**
124  * @brief Clears all timing violations (both current and recorded)
125  * @details This function clears all indicators that a timing violation has
126  * happened.
127  */
128 extern void SYSM_ClearAllTimingViolations(void);
129 
130 /**
131  * @brief Commits the stored changes to FRAM if necessary
132  * @details Writing to FRAM is costly (in terms of computation time), therefore
133  * it is decoupled from the main task of the sys mon module.
134  * When called, this function checks the flag sysm_flagFramCopyHasChanges
135  * and writes to FRAM if there are changes.
136  */
137 extern void SYSM_UpdateFramData(void);
138 
139 /**
140  * @brief Copy from the from entry to the to entry.
141  *
142  * @param[in] kpkFrom pointer to the origin struct
143  * @param[out] pTo pointer to the destination struct
144  */
145 extern void SYSM_CopyFramStruct(const FRAM_SYS_MON_RECORD_s *const kpkFrom, FRAM_SYS_MON_RECORD_s *pTo);
146 
147 /*========== Getter for static Variables (Unit Test) ========================*/
148 #ifdef UNITY_UNIT_TEST
150 
151 #endif
152 
153 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
154 
155 #endif /* FOXBMS__SYS_MON_H_ */
Header for the driver for the FRAM module.
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
struct that stores for each task the last violation of timing
Definition: fram_cfg.h:164
uint32_t duration
Definition: sys_mon.h:74
uint32_t timestampEnter
Definition: sys_mon.h:72
uint32_t timestampExit
Definition: sys_mon.h:73
SYSM_NOTIFY_TYPE_e state
Definition: sys_mon.h:71
SYSM_NOTIFICATION_s * TEST_SYSM_GetNotifications(void)
Definition: sys_mon.c:290
SYSM_NOTIFY_TYPE_e
Definition: sys_mon.h:64
@ SYSM_NOTIFY_ENTER
Definition: sys_mon.h:65
@ SYSM_NOTIFY_EXIT
Definition: sys_mon.h:66
void SYSM_GetRecordedTimingViolations(SYSM_TIMING_VIOLATION_RESPONSE_s *pAnswer)
Returns the timing violation flags determined from fram state.
Definition: sys_mon.c:200
void SYSM_ClearAllTimingViolations(void)
Clears all timing violations (both current and recorded)
Definition: sys_mon.c:232
void SYSM_CheckNotifications(void)
overall system monitoring
Definition: sys_mon.c:150
void SYSM_Notify(SYSM_TASK_ID_e taskId, SYSM_NOTIFY_TYPE_e state, uint32_t timestamp)
Sets needed bits to indicate that a task is running.
Definition: sys_mon.c:183
void SYSM_UpdateFramData(void)
Commits the stored changes to FRAM if necessary.
Definition: sys_mon.c:256
STD_RETURN_TYPE_e SYSM_Init(void)
initialization function for system monitoring
Definition: sys_mon.c:138
void SYSM_CopyFramStruct(const FRAM_SYS_MON_RECORD_s *const kpkFrom, FRAM_SYS_MON_RECORD_s *pTo)
Copy from the from entry to the to entry.
Definition: sys_mon.c:270
configuration of the system monitoring module
SYSM_TASK_ID_e
Definition: sys_mon_cfg.h:73