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

TODO. More...

#include "sys_mon_cfg.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
 

Typedefs

typedef enum SYSM_NOTIFY_TYPE SYSM_NOTIFY_TYPE_e
 
typedef struct SYSM_NOTIFICATION SYSM_NOTIFICATION_s
 

Enumerations

enum  SYSM_NOTIFY_TYPE { SYSM_NOTIFY_ENTER , SYSM_NOTIFY_EXIT }
 

Functions

void SYSM_CheckNotifications (void)
 overall system monitoring More...
 
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. More...
 

Detailed Description

TODO.

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
2020-01-21 (date of last update)
Prefix
SYSM

Definition in file sys_mon.h.

Typedef Documentation

◆ SYSM_NOTIFICATION_s

state (in summary) used for task or function notification

◆ SYSM_NOTIFY_TYPE_e

defines entry or exit

Enumeration Type Documentation

◆ SYSM_NOTIFY_TYPE

defines entry or exit

Enumerator
SYSM_NOTIFY_ENTER 

entry into a task

SYSM_NOTIFY_EXIT 

exit from a task

Definition at line 61 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 72 of file sys_mon.c.

Here is the call graph for this function:

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

Has to be called in every function using the system monitoring.

Parameters
tsk_idtask id to notify system monitoring
statewether function has been called at entry or exit
timetime

Definition at line 104 of file sys_mon.c.

Here is the call graph for this function: