/**************************************************************************
*
* Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved.
*
* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN
* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER.
*
* @file ModeFault.c
*
* @author (last) Sean Nash
* @date (last) 24-Sep-2020
*
* @author (original) Dara Navaei
* @date (original) 05-Nov-2019
*
***************************************************************************/

#include "AlarmLamp.h"
#include "BloodFlow.h"
#include "Buttons.h"
#include "DialInFlow.h"
#include "DialOutFlow.h"
#include "ModeFault.h"
#include "OperationModes.h"
#include "Valves.h"

/**
 *  @addtogroup HDFaultMode
 *  @{
 */

// ********** private data **********

// ********** private function prototypes **********

/*********************************************************************//**
 * @brief
 * The initFaultMode function initializes the Fault Mode module.
 * @details Inputs: none
 * @details Outputs: Fault Mode module initialized.
 * @return none
 *************************************************************************/
void initFaultMode( void )
{
    // TODO - anything to do here?
}

/*********************************************************************//**
 * @brief
 * The transitionToFaultMode function prepares for transition to fault mode.
 * @details Inputs: none
 * @details Outputs:
 * @return none
 *************************************************************************/
void transitionToFaultMode( void )
{
    // Set user alarm recovery actions allowed in this mode
    setAlarmUserActionEnabled( ALARM_USER_ACTION_RESUME, FALSE );
    setAlarmUserActionEnabled( ALARM_USER_ACTION_RINSEBACK, FALSE );
    setAlarmUserActionEnabled( ALARM_USER_ACTION_END_TREATMENT, FALSE );
}

/*********************************************************************//**
 * @brief
 * The execFaultMode function executes the Fault Mode state machine.
 * @details Inputs: none
 * @details Outputs:
 * @return current state (sub-mode)
 *************************************************************************/
U32 execFaultMode( void )
{
    BOOL stop = isStopButtonPressed();

#ifndef EMC_TEST_BUILD
    // Ensure all pumps are stopped
    signalBloodPumpHardStop();
    signalDialInPumpHardStop();
    signalDialOutPumpHardStop();
    // Ensure all valves are in safe position
    setValveAirTrap( STATE_CLOSED );
    setValvePosition( VDI, VALVE_POSITION_C_CLOSE );
    setValvePosition( VDO, VALVE_POSITION_C_CLOSE );
    setValvePosition( VBA, VALVE_POSITION_C_CLOSE );
    setValvePosition( VBV, VALVE_POSITION_C_CLOSE );
#else
    // TODO - EMC test code - remove later
    static U32 toggle = 0;
    static BOOL button_state = FALSE;

    if ( TRUE == stop )
    {
        if ( stop != button_state )
        {
            toggle = INC_WRAP( toggle, 0, 3 );
            switch ( toggle )
            {
                case 0: // Pumps and valves off
                    setValvePosition( VDI, VALVE_POSITION_C_CLOSE );
                    setValvePosition( VDO, VALVE_POSITION_C_CLOSE );
                    setValvePosition( VBA, VALVE_POSITION_C_CLOSE );
                    setValvePosition( VBV, VALVE_POSITION_C_CLOSE );
                    break;

                case 1: // Pumps on, valves off
                    setBloodPumpTargetFlowRate( 500, MOTOR_DIR_FORWARD, PUMP_CONTROL_MODE_OPEN_LOOP );
                    setDialInPumpTargetFlowRate( 500, MOTOR_DIR_FORWARD, PUMP_CONTROL_MODE_OPEN_LOOP );
                    setDialOutPumpTargetRate( 500, MOTOR_DIR_FORWARD, PUMP_CONTROL_MODE_OPEN_LOOP );
                    break;

                case 2: // Pumps on, valves on
                    setValvePosition( VDI, VALVE_POSITION_B_OPEN );
                    setValvePosition( VDO, VALVE_POSITION_B_OPEN );
                    setValvePosition( VBA, VALVE_POSITION_B_OPEN );
                    setValvePosition( VBV, VALVE_POSITION_B_OPEN );
                    break;

                case 3: // Pumps off, valves on
                    setBloodPumpTargetFlowRate( 0, MOTOR_DIR_FORWARD, PUMP_CONTROL_MODE_OPEN_LOOP );
                    setDialInPumpTargetFlowRate( 0, MOTOR_DIR_FORWARD, PUMP_CONTROL_MODE_OPEN_LOOP );
                    setDialOutPumpTargetRate( 0, MOTOR_DIR_FORWARD, PUMP_CONTROL_MODE_OPEN_LOOP );
                    break;

                default: // Should not get here, reset if we do
                    toggle = 0;
                    setBloodPumpTargetFlowRate( 0, MOTOR_DIR_FORWARD, PUMP_CONTROL_MODE_OPEN_LOOP );
                    setDialInPumpTargetFlowRate( 0, MOTOR_DIR_FORWARD, PUMP_CONTROL_MODE_OPEN_LOOP );
                    setDialOutPumpTargetRate( 0, MOTOR_DIR_FORWARD, PUMP_CONTROL_MODE_OPEN_LOOP );
                    setValvePosition( VDI, VALVE_POSITION_C_CLOSE );
                    setValvePosition( VDO, VALVE_POSITION_C_CLOSE );
                    setValvePosition( VBA, VALVE_POSITION_C_CLOSE );
                    setValvePosition( VBV, VALVE_POSITION_C_CLOSE );
                    break;
            }
        }
    }
    button_state = stop;
#endif

    return 0; // TODO - return current state
}

/*********************************************************************//**
 * @brief
 * The signalAlarmActionToFaultMode function executes the given alarm action
 * as appropriate while in Fault Mode.
 * @details Inputs: none
 * @details Outputs: given alarm action executed
 * @param action ID of alarm action to execute
 * @return none
 *************************************************************************/
void signalAlarmActionToFaultMode( ALARM_ACTION_T action )
{
    // Fault mode is terminal and already in safe state - no alarm actions handled in this mode.
}

/**@}*/