system monitoring module More...

#include "sys_mon.h"
#include "diag.h"
#include "fram.h"
#include "os.h"
#include <stdint.h>

Include dependency graph for sys_mon.c:

Functions
static void	SYSM_RecordTimingViolation (SYSM_TASK_ID_e taskId, uint32_t taskDuration, uint32_t timestampEnter)
	Records the violation of a timing in non volatile memory. More...

static bool	SYSM_ConvertRecordedTimingsToViolation (uint32_t duration, uint32_t timestampEnter)
	Convert recorded timings into a decision (bool) whether the timing has been violated or not. More...

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

Variables
static SYSM_NOTIFICATION_s	sysm_notifications [SYSM_TASK_ID_MAX]

static FRAM_SYS_MON_RECORD_s	sysm_localFramCopy = {0}

static volatile bool	sysm_flagFramCopyHasChanges = false

Detailed Description

system monitoring module

Copyright: © 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
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: 2023-10-12 (date of last update)

Version: v1.6.0

Prefix: SYSM

Definition in file sys_mon.c.

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 152 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 234 of file sys_mon.c.

Here is the call graph for this function:

◆ SYSM_ConvertRecordedTimingsToViolation()

static bool SYSM_ConvertRecordedTimingsToViolation	(	uint32_t	duration,
		uint32_t	timestampEnter
	)

static

Convert recorded timings into a decision (bool) whether the timing has been violated or not.

Timing has been violated if both duration or timestamp are not equal to zero

Parameters

[in]	duration	duration in ticks
[in]	timestampEnter	entry timestamp in ticks

Returns: bool describing whether this is a violation (true) or not (false)

Definition at line 131 of file sys_mon.c.

◆ 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]	kpkFrom	pointer to the origin struct
[out]	pTo	pointer to the destination struct

Definition at line 272 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] pAnswer pointer to a SYSM_TIMING_VIOLATION_RESPONSE_s struct that will be filled by the function

Definition at line 202 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 140 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

taskId	task id to notify system monitoring
state	whether function has been called at entry or exit
timestamp	time

Definition at line 185 of file sys_mon.c.

Here is the call graph for this function:

◆ SYSM_RecordTimingViolation()

static void SYSM_RecordTimingViolation	(	SYSM_TASK_ID_e	taskId,
		uint32_t	taskDuration,
		uint32_t	timestampEnter
	)

static

Records the violation of a timing in non volatile memory.

Parameters

[in]	taskId	id of the violating task
[in]	taskDuration	duration of the task when recording the violation
[in]	timestampEnter	timestamp that the task has entered

Definition at line 97 of file sys_mon.c.

◆ 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 258 of file sys_mon.c.

Here is the call graph for this function:

Variable Documentation

◆ sysm_flagFramCopyHasChanges

volatile bool sysm_flagFramCopyHasChanges = false

static

flag, indicating that the FRAM entry has been changed and should be written

Definition at line 73 of file sys_mon.c.

◆ sysm_localFramCopy

FRAM_SYS_MON_RECORD_s sysm_localFramCopy = {0}

static

local shadow copy of the FRAM entry

Definition at line 70 of file sys_mon.c.

◆ sysm_notifications

SYSM_NOTIFICATION_s sysm_notifications[SYSM_TASK_ID_MAX]

static

tracking variable for System monitoring notifications

Definition at line 67 of file sys_mon.c.

Functions

Variables

Detailed Description

Function Documentation

◆ SYSM_CheckNotifications()

◆ SYSM_ClearAllTimingViolations()

◆ SYSM_ConvertRecordedTimingsToViolation()

◆ SYSM_CopyFramStruct()

◆ SYSM_GetRecordedTimingViolations()

◆ SYSM_Init()

◆ SYSM_Notify()

◆ SYSM_RecordTimingViolation()

◆ SYSM_UpdateFramData()

Variable Documentation

◆ sysm_flagFramCopyHasChanges

◆ sysm_localFramCopy

◆ sysm_notifications