foxBMS - Unit Tests
1.4.1
The foxBMS Unit Tests API Documentation
|
system monitoring module More...
Go to the source code of this file.
Data Structures | |
struct | SYSM_NOTIFICATION_s |
struct | SYSM_TIMING_VIOLATION_RESPONSE_s |
Enumerations | |
enum | SYSM_NOTIFY_TYPE_e { SYSM_NOTIFY_ENTER , SYSM_NOTIFY_EXIT } |
Functions | |
STD_RETURN_TYPE_e | SYSM_Init (void) |
initialization function for system monitoring More... | |
void | SYSM_CheckNotifications (void) |
overall system monitoring More... | |
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. More... | |
void | SYSM_GetRecordedTimingViolations (SYSM_TIMING_VIOLATION_RESPONSE_s *pAnswer) |
Returns the timing violation flags determined from fram state. More... | |
void | SYSM_ClearAllTimingViolations (void) |
Clears all timing violations (both current and recorded) More... | |
void | SYSM_UpdateFramData (void) |
Commits the stored changes to FRAM if necessary. More... | |
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. More... | |
SYSM_NOTIFICATION_s * | TEST_SYSM_GetNotifications (void) |
system monitoring module
SPDX-License-Identifier: BSD-3-Clause
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:
Definition in file sys_mon.h.
enum SYSM_NOTIFY_TYPE_e |
void SYSM_CheckNotifications | ( | void | ) |
overall system monitoring
checks notifications (state and timestamps) of all system-relevant tasks or functions all checks should be customized corresponding to its timing and state requirements
early exit if nothing to do
Definition at line 150 of file sys_mon.c.
void SYSM_ClearAllTimingViolations | ( | void | ) |
void SYSM_CopyFramStruct | ( | const FRAM_SYS_MON_RECORD_s *const | kpkFrom, |
FRAM_SYS_MON_RECORD_s * | pTo | ||
) |
void SYSM_GetRecordedTimingViolations | ( | SYSM_TIMING_VIOLATION_RESPONSE_s * | pAnswer | ) |
Returns the timing violation flags determined from fram state.
This function reads the timing states and determines if a violation has occurred.
[out] | pAnswer | pointer to a SYSM_TIMING_VIOLATION_RESPONSE_s struct that will be filled by the function |
Definition at line 200 of file sys_mon.c.
STD_RETURN_TYPE_e SYSM_Init | ( | void | ) |
initialization function for system monitoring
Has to be called once after startup to initialize and check system monitoring related functionality
Definition at line 138 of file sys_mon.c.
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.
Has to be called in every function using the system monitoring.
taskId | task id to notify system monitoring |
state | whether function has been called at entry or exit |
timestamp | time |
Definition at line 183 of file sys_mon.c.
void SYSM_UpdateFramData | ( | void | ) |
Commits the stored changes to FRAM if necessary.
Writing to FRAM is costly (in terms of computation time), therefore it is decoupled from the main task of the sys mon module. When called, this function checks the flag sysm_flagFramCopyHasChanges and writes to FRAM if there are changes.
Definition at line 256 of file sys_mon.c.
SYSM_NOTIFICATION_s* TEST_SYSM_GetNotifications | ( | void | ) |