rusefi/firmware/controllers/core/error_handling.h

/**
 * @file	error_handling.h
 *
 * @date Mar 6, 2014
 * @author Andrey Belomutskiy, (c) 2012-2017
 */

#ifndef ERROR_HANDLING_H_
#define ERROR_HANDLING_H_

#include "global.h"
#include "obd_error_codes.h"

#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */

/**
 * Something is wrong, but we can live with it: some minor sensor is disconnected
 * or something like that
 *
 * see also firmwareError()
 */
bool warning(obd_code_e code, const char *fmt, ...);

typedef uint8_t fatal_msg_t[200];
/**
 * Something really bad had happened - firmware cannot function, we cannot run the engine
 *
 * see also warning()
 */
void firmwareError(obd_code_e code, const char *fmt, ...);

#define hasFirmwareError() hasFirmwareErrorFlag

// todo: rename to getFatalErrorMessage
char *getFirmwareError(void);

void initErrorHandlingDataStructures(void);
// todo: rename to getWarningMessage?
char *getWarning(void);

// todo: better place for this shared declaration?
int getRusEfiVersion(void);

/**
 * @deprecated Global panic is inconvenient because it's hard to deliver the error message while whole instance
 * is stopped. Please use firmwareWarning() instead
 */
#if EFI_ENABLE_ASSERTS
  #define efiAssert(code, condition, message, result) { if (!(condition)) { firmwareError(code, message); return result; } }
  #define efiAssertVoid(code, condition, message) { if (!(condition)) { firmwareError(code, message); return; } }
#else /* EFI_ENABLE_ASSERTS */
  #define efiAssert(code, condition, message, result) { }
  #define efiAssertVoid(code, condition, message) { }
#endif /* EFI_ENABLE_ASSERTS */

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* ERROR_HANDLING_H_ */