sys_mon_cfg.h File Reference

TODO. More...

#include "general.h"
#include "diag_cfg.h"

Include dependency graph for sys_mon_cfg.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	SYSM_CH_CFG

Typedefs
typedef enum SYSM_HANDLING_TYPE	SYSM_HANDLING_TYPE_e
typedef enum SYSM_TASK_ID	SYSM_TASK_ID_e
typedef enum SYSM_RECORDING	SYSM_RECORDING_e
typedef enum SYSM_ACTIVATE	SYSM_ACTIVATE_e
typedef struct SYSM_CH_CFG	SYSM_MONITORING_CFG_s

Enumerations
enum	SYSM_HANDLING_TYPE { SYSM_HANDLING_DONOTHING , SYSM_HANDLING_SWITCHOFFCONTACTOR }
enum	SYSM_TASK_ID {   SYSM_TASK_ID_ENGINE , SYSM_TASK_ID_CYCLIC_1ms , SYSM_TASK_ID_CYCLIC_10ms , SYSM_TASK_ID_CYCLIC_100ms ,   SYSM_TASK_ID_CYCLIC_ALGORITHM_100ms , SYSM_TASK_ID_MAX }
enum	SYSM_RECORDING { SYSM_RECORDING_ENABLED , SYSM_RECORDING_DISABLED }
enum	SYSM_ACTIVATE { SYSM_ENABLED , SYSM_DISABLED }

Functions
STD_RETURN_TYPE_e	SYSM_Init (void)
	initialization function for system monitoring More...
void	TEST_SYSM_DummyCallback (SYSM_TASK_ID_e taskId)

Variables
SYSM_MONITORING_CFG_s	sysm_ch_cfg []

Detailed Description

TODO.

Copyright

© 2010 - 2021, 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:

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

2021-11-10 (date of last update)

Prefix

SYSM

Definition in file sys_mon_cfg.h.

Typedef Documentation

SYSM_ACTIVATE_e

typedef enum SYSM_ACTIVATE SYSM_ACTIVATE_e

enable diagnosis entry for system monitoring

SYSM_HANDLING_TYPE_e

typedef enum SYSM_HANDLING_TYPE SYSM_HANDLING_TYPE_e

diagnosis handling type for system monitoring

SYSM_MONITORING_CFG_s

typedef struct SYSM_CH_CFG SYSM_MONITORING_CFG_s

Channel configuration of one system monitoring channel

SYSM_RECORDING_e

typedef enum SYSM_RECORDING SYSM_RECORDING_e

recording activation

SYSM_TASK_ID_e

typedef enum SYSM_TASK_ID SYSM_TASK_ID_e

listing of system-relevant tasks or functions which are checked by the system monitoring

Enumeration Type Documentation

SYSM_ACTIVATE

enum SYSM_ACTIVATE

enable diagnosis entry for system monitoring

Enumerator
SYSM_ENABLED	TODO
SYSM_DISABLED	TODO

Definition at line 88 of file sys_mon_cfg.h.

SYSM_HANDLING_TYPE

enum SYSM_HANDLING_TYPE

diagnosis handling type for system monitoring

Enumerator
SYSM_HANDLING_DONOTHING
SYSM_HANDLING_SWITCHOFFCONTACTOR

Definition at line 63 of file sys_mon_cfg.h.

SYSM_RECORDING

enum SYSM_RECORDING

recording activation

Enumerator
SYSM_RECORDING_ENABLED	enable event recording
SYSM_RECORDING_DISABLED	disable event recording

Definition at line 82 of file sys_mon_cfg.h.

SYSM_TASK_ID

enum SYSM_TASK_ID

listing of system-relevant tasks or functions which are checked by the system monitoring

Enumerator
SYSM_TASK_ID_ENGINE	diag entry for engine task
SYSM_TASK_ID_CYCLIC_1ms	diag entry for engine cyclic 1ms task
SYSM_TASK_ID_CYCLIC_10ms	diag entry for engine cyclic 10ms task
SYSM_TASK_ID_CYCLIC_100ms	diag entry for engine cyclic 100ms task
SYSM_TASK_ID_CYCLIC_ALGORITHM_100ms	diag entry for algorithm cyclic 100ms task
SYSM_TASK_ID_MAX	end marker do not delete

Definition at line 72 of file sys_mon_cfg.h.

Function Documentation

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 117 of file sys_mon_cfg.c.

TEST_SYSM_DummyCallback()

void TEST_SYSM_DummyCallback

(

SYSM_TASK_ID_e

taskId

)

Definition at line 128 of file sys_mon_cfg.c.

Here is the call graph for this function:

Variable Documentation

sysm_ch_cfg

SYSM_MONITORING_CFG_s sysm_ch_cfg[]

extern

diag system monitoring struct

Definition at line 66 of file sys_mon_cfg.c.