foxBMS
1.1.0
The foxBMS Battery Management System API Documentation
|
Diagnosis driver header. More...
#include "diag_cfg.h"
Go to the source code of this file.
Data Structures | |
struct | DIAG |
Typedefs | |
typedef enum DIAG_RETURNTYPE | DIAG_RETURNTYPE_e |
typedef struct DIAG | DIAG_s |
Functions | |
DIAG_RETURNTYPE_e | DIAG_Handler (DIAG_ID_e diag_id, DIAG_EVENT_e event, DIAG_IMPACT_LEVEL_e impact, uint32_t data) |
DIAG_Handler provides generic error handling, based on diagnosis group. More... | |
STD_RETURN_TYPE_e | DIAG_CheckEvent (STD_RETURN_TYPE_e cond, DIAG_ID_e diag_id, DIAG_IMPACT_LEVEL_e impact, uint32_t data) |
DIAG_CheckEvent provides a simple interface to check an event for STD_OK. More... | |
STD_RETURN_TYPE_e | DIAG_Initialize (DIAG_DEV_s *diag_dev_pointer) |
DIAG_Init initializes all needed structures/buffers. More... | |
STD_RETURN_TYPE_e | DIAG_GetDiagnosisEntryState (DIAG_ID_e diagnosisEntry) |
Checks if passed diagnosis entry has been triggered or not. More... | |
void | DIAG_PrintErrors (void) |
Prints contents of the error buffer on user request. More... | |
uint32_t | DIAG_GetDelay (DIAG_ID_e diagnosisEntry) |
Get configured delay of passed diagnosis entry. More... | |
bool | DIAG_IsAnyFatalErrorSet (void) |
Check if any fatal error is set. More... | |
Diagnosis driver header.
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 diag.h.
typedef enum DIAG_RETURNTYPE DIAG_RETURNTYPE_e |
diagnosis handler return types
enum DIAG_RETURNTYPE |
diagnosis handler return types
enum DIAG_STATE_e |
STD_RETURN_TYPE_e DIAG_CheckEvent | ( | STD_RETURN_TYPE_e | cond, |
DIAG_ID_e | diag_id, | ||
DIAG_IMPACT_LEVEL_e | impact, | ||
uint32_t | data | ||
) |
DIAG_CheckEvent provides a simple interface to check an event for STD_OK.
DIAG_CheckEvent is a wrapper function for DIAG_Handler(). In simple cases where a return value that is not STD_OK (or a 0 casted to STD_OK) should increase the error counter in a diagnosis channel, this function should be used instead of directly calling the DIAG_Handler().
cond | condition |
diag_id | event ID of the event that has occurred |
impact | DIAG_IMPACT_LEVEL_e of DIAG_ID_e |
data | individual information for DIAG_ID_e e.g. string number,.. |
Definition at line 353 of file diag.c.
uint32_t DIAG_GetDelay | ( | DIAG_ID_e | diagnosisEntry | ) |
STD_RETURN_TYPE_e DIAG_GetDiagnosisEntryState | ( | DIAG_ID_e | diagnosisEntry | ) |
Checks if passed diagnosis entry has been triggered or not.
diagnosisEntry | event ID of diagnosis entry |
DIAG_RETURNTYPE_e DIAG_Handler | ( | DIAG_ID_e | diag_id, |
DIAG_EVENT_e | event, | ||
DIAG_IMPACT_LEVEL_e | impact, | ||
uint32_t | data | ||
) |
DIAG_Handler provides generic error handling, based on diagnosis group.
This function calls the handler functions depending on the diagnosis group of call. It needs to get called in every function which wants to apply some kind of diagnosis handling. According to its return value further treatment is either left to the calling module itself, or can be done in the callback function defined in diag_cfg.c
diag_id | DIAG_ID_e of the event that has occurred |
event | event that occurred (OK, NOK, RESET) |
impact | DIAG_IMPACT_LEVEL_e of DIAG_ID_e |
data | individual information for DIAG_ID_e e.g. string number,.. |
Definition at line 226 of file diag.c.
STD_RETURN_TYPE_e DIAG_Initialize | ( | DIAG_DEV_s * | diag_dev_pointer | ) |
DIAG_Init initializes all needed structures/buffers.
This function provides initialization of the diagnose module. In case of miss behaviour it calls Reset and adds an entry into database to ensure data validity/report back malfunction
diag_dev_pointer |
Definition at line 111 of file diag.c.
bool DIAG_IsAnyFatalErrorSet | ( | void | ) |
Check if any fatal error is set.
Definition at line 374 of file diag.c.