#include "string.h"     // for memset(), memcpy()

#include "gio.h"        // hal headers
#include "sci.h"
#include "sys_dma.h"

#include "Comm.h"
#include "Compatible.h"
#include "FPGA.h"
#include "Messaging.h"
#include "OperationModes.h"
#include "PersistentAlarm.h"
#include "Timers.h"
#include "Utilities.h"

/**
 *  @addtogroup FpgaRO
 *  @{
 */

// ********** private definitions **********

#define MAX_FPGA_COMM_FAILURES_WINDOW_MS ( 1 * SEC_PER_MIN * MS_PER_SECOND ) ///< FPGA comm failures window
#define MAX_FPGA_COMM_FAILURES           3                                   ///< FPGA maximum comm failures per MAX_FPGA_COMM_FAILURES_WINDOW_MS
#define MIN_POWER_ON_TIME_FOR_COMM_FAILS ( 1 * MS_PER_SECOND )               ///< Allow FPGA comm errors for first second after power-up

/*********************************************************************//**
 * @brief
 * The initFPGARO function initializes the RO FPGA unit.
 * @details \b Inputs: none
 * @details \b Outputs: FPGA unit initialized.
 * @return none
 *************************************************************************/
void initFPGARO( void )
{

    // initialize FPGA clock speed error time windowed count
    initTimeWindowedCount( TIME_WINDOWED_COUNT_FPGA_COMM_FAILURES, MAX_FPGA_COMM_FAILURES, MAX_FPGA_COMM_FAILURES_WINDOW_MS);
}

/*********************************************************************//**
 * @brief
 * The checkFPGACommFailure function increments the FPGA comm failure
 * windowed timer and returns whether or not the number of failures in
 * the window have been reached.
 * @details \b Inputs: none
 * @details \b Outputs: none
 * @return TRUE if windowed count exceeded, else false.
 *************************************************************************/
void checkFPGACommFailure( void )
{
    if ( getMSTimerCount() > MIN_POWER_ON_TIME_FOR_COMM_FAILS )
    {
        if ( TRUE == incTimeWindowedCount( TIME_WINDOWED_COUNT_FPGA_COMM_FAILURES ) )
        {
            // TODO uncomment
            //SET_ALARM_WITH_2_U32_DATA( ALARM_ID_RO_FPGA_COMM_TIMEOUT, MAX_FPGA_COMM_FAILURES, (U32)fpgaSensorReadings.fpgaIOErrorCntProcessor )
        }
    }
}

/*********************************************************************//**
 * @brief
 * The checkFPGAAFEOEFailure function increments the FPGA comm failure
 * windowed timer if an FE or OE error has occurred and returns whether
 * or not the number of failures in
 * the window have been reached.
 * @details \b Inputs: none
 * @details \b Outputs: none
 * @details \b Alarm: ALARM_ID_DD_FPGA_COMM_TIMEOUT when FPGA communication is
 * lost with the processor.
 * @return TRUE if windowed count exceeded, else false.
 *************************************************************************/
BOOL checkFPGAFEOEFailure( void )
{
    BOOL status = FALSE;
    BOOL FPGAFEOEError = getSci2FEOEError();

    if ( TRUE == FPGAFEOEError)
    {
        if ( getMSTimerCount() > MIN_POWER_ON_TIME_FOR_COMM_FAILS )
        {
            if ( TRUE == incTimeWindowedCount( TIME_WINDOWED_COUNT_FPGA_COMM_FAILURES ) )
            {
                // TODO uncomment
                //SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_FPGA_COMM_TIMEOUT, MAX_FPGA_COMM_FAILURES, (U32)fpgaSensorReadings.fpgaIOErrorCntProcessor )
                status = TRUE;
            }
        }
    }

    return status;
}

/**@}*/