15ab232e82
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@427 05563f52-14a8-4384-a975-3d1654cca0fa
117 lines
3.4 KiB
C
117 lines
3.4 KiB
C
// -----------------------------------------------------------------------------
|
|
/// @file Warning.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
|
|
// -----------------------------------------------------------------------------
|
|
|
|
/**
|
|
* %Warning implementation
|
|
* \defgroup Warning Package Warning
|
|
* \ingroup hsb-mrts
|
|
* @{
|
|
*/
|
|
|
|
#ifndef WARNING_H_
|
|
#define WARNING_H_
|
|
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// Include files
|
|
// -----------------------------------------------------------------------------
|
|
|
|
#include "stm32f10x.h"
|
|
|
|
#include "Observable.h"
|
|
|
|
#include "FreeRTOS.h"
|
|
#include "task.h"
|
|
// -----------------------------------------------------------------------------
|
|
// Constant and macro definitions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// Type definitions.
|
|
// -----------------------------------------------------------------------------
|
|
|
|
typedef enum
|
|
{
|
|
WARNING_INTERLOCK_COMMON_FAIL,
|
|
} T_WarningCode;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// Function declarations
|
|
// -----------------------------------------------------------------------------
|
|
|
|
///TODO TEMPORARY
|
|
extern TaskHandle_t warningTaskHandle;
|
|
|
|
/** ----------------------------------------------------------------------------
|
|
* Warning_construct
|
|
* Constructs the Warning handler
|
|
*
|
|
* @return ErrorStatus SUCCESS if construction was successful
|
|
* ERROR otherwise
|
|
*
|
|
* @todo
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
extern ErrorStatus Warning_construct(void);
|
|
|
|
|
|
/** ----------------------------------------------------------------------------
|
|
* Warning_getObservable
|
|
* Returns the observable of the Warning handler
|
|
*
|
|
* @return struct Observable* Observable of the Warning handler
|
|
*
|
|
* @todo
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
extern struct Observable* Warning_getObservable(void);
|
|
|
|
|
|
/** ----------------------------------------------------------------------------
|
|
* Warning_postWarning
|
|
* Posts a new Warning
|
|
*
|
|
* @param warningCode Warning CODE
|
|
*
|
|
* @return void
|
|
*
|
|
* @todo
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
extern void Warning_postWarning(T_WarningCode warningCode);
|
|
|
|
|
|
/** ----------------------------------------------------------------------------
|
|
* Warning_postWarningFromISR
|
|
* Posts a new Warning from an ISR context
|
|
*
|
|
* @param warningCode Warning CODE
|
|
*
|
|
* @return void
|
|
*
|
|
* @todo
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
extern void Warning_postWarningFromISR(T_WarningCode warningCode);
|
|
|
|
#endif /* WARNING_H_ */
|
|
|
|
/** @} */
|