Files
hsb/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/hsb-mrts/inc/Error.h
mmi 088ce81dc7 Most parts of the menu structure are functional.
Error handler added
Screens for warning, pause, FINISH etc yet to be added

git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@255 05563f52-14a8-4384-a975-3d1654cca0fa
2017-10-17 15:23:56 +00:00

120 lines
3.3 KiB
C

// -----------------------------------------------------------------------------
/// @file Error.h
/// @brief File description
// -----------------------------------------------------------------------------
// Micro-Key bv
// Industrieweg 28, 9804 TG Noordhorn
// Postbus 92, 9800 AB Zuidhorn
// The Netherlands
// Tel: +31 594 503020
// Fax: +31 594 505825
// Email: support@microkey.nl
// Web: www.microkey.nl
// -----------------------------------------------------------------------------
/// $Revision$
/// $Author$
/// $Date$
// (c) 2015 Micro-Key bv
// -----------------------------------------------------------------------------
/// @defgroup {group_name} {group_description}
/// Description
/// @file Error.h
/// @ingroup {group_name}
#ifndef ERROR_H_
#define ERROR_H_
// -----------------------------------------------------------------------------
// Include files
// -----------------------------------------------------------------------------
#include "stm32f10x.h"
#include "Observable.h"
// -----------------------------------------------------------------------------
// Constant and macro definitions
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------
// Type definitions.
// -----------------------------------------------------------------------------
typedef enum
{
GPIO_FAIL,
INTERLOCK_COMMON_FAIL,
INTERLOCK_TESLA_FAIL,
POWERENABLE_FAIL,
REPAIR_FAIL,
} T_ErrorCode;
// -----------------------------------------------------------------------------
// Function declarations
// -----------------------------------------------------------------------------
/** ----------------------------------------------------------------------------
* Error_construct
* Constructs the error handler
*
* @return ErrorStatus SUCCESS if construction was successful
* ERROR otherwise
*
* @todo
* -----------------------------------------------------------------------------
*/
extern ErrorStatus Error_construct(void);
/** ----------------------------------------------------------------------------
* Error_getObservable
* Returns the observable of the Error handler
*
* @return struct Observable* Observable of the ERROR handler
*
* @todo
* -----------------------------------------------------------------------------
*/
extern struct Observable* Error_getObservable(void);
/** ----------------------------------------------------------------------------
* Error_postError
* Posts a new error
*
* @param errorCode ERROR CODE
*
* @return void
*
* @todo
* -----------------------------------------------------------------------------
*/
extern void Error_postError(T_ErrorCode errorCode);
/** ----------------------------------------------------------------------------
* Error_postErrorFromISR
* Posts a new error from an ISR context
*
* @param errorCode ERROR CODE
*
* @return void
*
* @todo
* -----------------------------------------------------------------------------
*/
extern void Error_postErrorFromISR(T_ErrorCode errorCode);
#endif /* ERROR_H_ */