// -----------------------------------------------------------------------------
/// @file  PowerLossDetector.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
// -----------------------------------------------------------------------------

/**
 * PowerLossDetector implementation
 * \defgroup PowerLossDetector Package PowerLossDetector
 * \ingroup hsb-mrts
 * @{
 */

#ifndef POWERLOSSDETECTOR_H_
#define POWERLOSSDETECTOR_H_


// -----------------------------------------------------------------------------
// Include files 
// -----------------------------------------------------------------------------

#include "stm32f10x.h"

#include "CachedStorage.h"
#include "MemoryDevice.h"

// -----------------------------------------------------------------------------
// Constant and macro definitions 
// -----------------------------------------------------------------------------



// -----------------------------------------------------------------------------
// Type definitions. 
// -----------------------------------------------------------------------------



// -----------------------------------------------------------------------------
// Function declarations 
// -----------------------------------------------------------------------------


/** ----------------------------------------------------------------------------
 * PowerLossDetector_construct
 * Description of function
 *
 * @param	memoryDevice
 *
 * @return	ErrorStatus
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern ErrorStatus PowerLossDetector_construct(struct MemoryDevice* memoryDevice, unsigned int pageNumber, unsigned int startAddress, unsigned int length);


/** ----------------------------------------------------------------------------
 * PowerLossDetector_destruct
 * Description of function
 *
 *
 * @return	void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void PowerLossDetector_destruct(void);


/** ----------------------------------------------------------------------------
 * PowerLossDetector_setBusyFlag
 * Description of function
 *
 * @return	void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void PowerLossDetector_setBusyFlag(void);


/** ----------------------------------------------------------------------------
 * PowerLossDetector_clearBusyFlag
 * Description of function
 *
 * @return  void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void PowerLossDetector_clearBusyFlag(void);


/** ----------------------------------------------------------------------------
 * PowerLossDetection_isFlagSet
 * Description of function
 *
 * @return	bool
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern bool PowerLossDetection_isFlagSet(void);

#endif /* POWERLOSSDETECTOR_H_ */

/** @} */