foxBMS
1.1.0
The foxBMS Battery Management System API Documentation
sys_mon.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.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
48
* @prefix SYSM
49
*
50
* @brief TODO
51
*/
52
53
#ifndef FOXBMS__SYS_MON_H_
54
#define FOXBMS__SYS_MON_H_
55
56
/*========== Includes =======================================================*/
57
#include "
sys_mon_cfg.h
"
58
59
/*========== Macros and Definitions =========================================*/
60
/** defines entry or exit */
61
typedef
enum
SYSM_NOTIFY_TYPE
{
62
SYSM_NOTIFY_ENTER
,
/**< entry into a task */
63
SYSM_NOTIFY_EXIT
,
/**< exit from a task */
64
}
SYSM_NOTIFY_TYPE_e
;
65
66
/** state (in summary) used for task or function notification */
67
typedef
struct
SYSM_NOTIFICATION
{
68
SYSM_NOTIFY_TYPE_e
state
;
/**< state of the task */
69
uint32_t
timestampEnter
;
/**< timestamp of entry into state */
70
uint32_t
timestampExit
;
/**< timestamp of exit from state */
71
uint32_t
duration
;
/**< duration between last complete entry and exit cycle */
72
}
SYSM_NOTIFICATION_s
;
73
74
/*========== Extern Constant and Variable Declarations ======================*/
75
76
/*========== Extern Function Prototypes =====================================*/
77
/**
78
* @brief overall system monitoring
79
* @details checks notifications (state and timestamps) of all system-relevant
80
* tasks or functions all checks should be customized corresponding
81
* to its timing and state requirements
82
*/
83
extern
void
SYSM_CheckNotifications
(
void
);
84
85
/**
86
* @brief Sets needed bits to indicate that a task is running
87
* @details Has to be called in every function using the system monitoring.
88
* @param tsk_id task id to notify system monitoring
89
* @param state wether function has been called at entry or exit
90
* @param time time
91
*/
92
extern
void
SYSM_Notify
(
SYSM_TASK_ID_e
tsk_id,
SYSM_NOTIFY_TYPE_e
state, uint32_t time);
93
94
/*========== Getter for static Variables (Unit Test) ========================*/
95
#ifdef UNITY_UNIT_TEST
96
extern
SYSM_NOTIFICATION_s
*TEST_SYSM_GetNotifications(
void
);
97
98
#endif
99
100
/*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
101
102
#endif
/* FOXBMS__SYS_MON_H_ */
SYSM_NOTIFICATION
Definition:
sys_mon.h:67
SYSM_NOTIFICATION::duration
uint32_t duration
Definition:
sys_mon.h:71
SYSM_NOTIFICATION::timestampEnter
uint32_t timestampEnter
Definition:
sys_mon.h:69
SYSM_NOTIFICATION::state
SYSM_NOTIFY_TYPE_e state
Definition:
sys_mon.h:68
SYSM_NOTIFICATION::timestampExit
uint32_t timestampExit
Definition:
sys_mon.h:70
SYSM_NOTIFICATION_s
struct SYSM_NOTIFICATION SYSM_NOTIFICATION_s
SYSM_CheckNotifications
void SYSM_CheckNotifications(void)
overall system monitoring
Definition:
sys_mon.c:72
SYSM_NOTIFY_TYPE_e
enum SYSM_NOTIFY_TYPE SYSM_NOTIFY_TYPE_e
SYSM_NOTIFY_TYPE
SYSM_NOTIFY_TYPE
Definition:
sys_mon.h:61
SYSM_NOTIFY_ENTER
@ SYSM_NOTIFY_ENTER
Definition:
sys_mon.h:62
SYSM_NOTIFY_EXIT
@ SYSM_NOTIFY_EXIT
Definition:
sys_mon.h:63
SYSM_Notify
void SYSM_Notify(SYSM_TASK_ID_e tsk_id, SYSM_NOTIFY_TYPE_e state, uint32_t time)
Sets needed bits to indicate that a task is running.
Definition:
sys_mon.c:104
sys_mon_cfg.h
TODO.
SYSM_TASK_ID_e
enum SYSM_TASK_ID SYSM_TASK_ID_e
src
app
engine
sys_mon
sys_mon.h
Generated by
1.9.1