foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
sys_mon.h File Reference

system monitoring module More...

#include "sys_mon_cfg.h"
#include "fram.h"
Include dependency graph for sys_mon.h:
This graph shows which files directly or indirectly include this file:

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...
 

Detailed Description

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:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2019-11-28 (date of creation)
Updated
2022-07-28 (date of last update)
Version
v1.4.0
Prefix
SYSM

Definition in file sys_mon.h.

Enumeration Type Documentation

◆ SYSM_NOTIFY_TYPE_e

defines entry or exit

Enumerator
SYSM_NOTIFY_ENTER 

entry into a task

SYSM_NOTIFY_EXIT 

exit from a task

Definition at line 64 of file sys_mon.h.

Function Documentation

◆ SYSM_CheckNotifications()

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.

Here is the call graph for this function:

◆ SYSM_ClearAllTimingViolations()

void SYSM_ClearAllTimingViolations ( void  )

Clears all timing violations (both current and recorded)

This function clears all indicators that a timing violation has happened.

Definition at line 232 of file sys_mon.c.

Here is the call graph for this function:

◆ SYSM_CopyFramStruct()

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.

Parameters
[in]kpkFrompointer to the origin struct
[out]pTopointer to the destination struct

Definition at line 270 of file sys_mon.c.

◆ SYSM_GetRecordedTimingViolations()

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.

Parameters
[out]pAnswerpointer to a SYSM_TIMING_VIOLATION_RESPONSE_s struct that will be filled by the function

Definition at line 200 of file sys_mon.c.

Here is the call graph for this function:

◆ SYSM_Init()

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

Returns
STD_OK if no configuration error detected, otherwise STD_NOT_OK

Definition at line 138 of file sys_mon.c.

Here is the call graph for this function:

◆ SYSM_Notify()

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.

Parameters
taskIdtask id to notify system monitoring
statewhether function has been called at entry or exit
timestamptime

Definition at line 183 of file sys_mon.c.

Here is the call graph for this function:

◆ SYSM_UpdateFramData()

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.

Here is the call graph for this function: