/**************************************************************************
*
* Copyright (c) 2025-2025 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    ModePreGenDialysate.c
*
* @author  (last)      Vinayakam Mani
* @date    (last)      17-Apr-2025
*
* @author  (original)  Vinayakam Mani
* @date    (original)  17-Apr-2025
*
***************************************************************************/

#include "ConcentratePumps.h"
#include "DialysatePumps.h"
#include "Heaters.h"
#include "ModePreGenDialysate.h"
#include "ModeGenDialysate.h"
#include "ModeFault.h"
#include "Messaging.h"
#include "OperationModes.h"
#include "Pressure.h"
#include "TaskGeneral.h"
#include "Timers.h"
#include "Utilities.h"
#include "Valves.h"

/**
 *  @addtogroup DDPreGenDialysateMode
 *  @{
 */

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

/// Interval (ms/task time) at which the pre-treatment state data is published on the CAN bus.
#define PRE_GEN_DIALYSATE_DATA_PUB_INTERVAL               ( 250 / TASK_GENERAL_INTERVAL )                   ///< Interval (ms/task time) at which the pre-gen dialysate mode data published.
#define HYD_CHAMBER_PRES_CHECK_TIME_OUT                   ( 30 * MS_PER_SECOND )                            ///< Time out period when hydraulics chamber pressure check initiated
#define NEG_PRES_PERSISTENCE_TIME_MS                      ( 1 * MS_PER_SECOND )                             ///< Persistence time for Hydraulics chamber negative degassing pressure check.

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

static DD_PRE_GEN_DIALYSATE_STATE_T preGenDialysateState;                                                   ///< Currently active pre-gen dialysate state.
static DD_WET_SELF_TEST_STATE_T wetSelfTestState;                                                           ///< Currently active pre-gen Wet self test state.
static U32 hydChamberPressureCheckStartTimeMS;                                                              ///< Current time when hydraulics chamber pressure check started in milliseconds.
static U32 pressureCheckPersistanceStartTimeMS;                                                             ///< Current time for pressure check persistance time started in milliseconds.
static BOOL pendingStartDDGenDialRequest;                                                                   ///< Flag indicating TD has requested DD start the generation dialysate request.
static BOOL pendingStopDDPreGenDialRequest;                                                                 ///< Flag indicating TD has requested DD stop the pre generation dialysate.
static U32 preGenDialysatePublishTimerCounter;                                                              ///< Pre-Gen Dialysate data broadcast timer counter used to schedule when to transmit data.
static OVERRIDE_U32_T preGenDialysateModePublishInterval;                                                   ///< Interval (in task intervals) at which to publish pre-gen dialysate mode data to CAN bus.

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

static void publishPreGenDialysateState( void );
static DD_PRE_GEN_DIALYSATE_STATE_T handlePreGenDialysateFillCompleteCheckState( void );
static DD_PRE_GEN_DIALYSATE_STATE_T handlePreGenWetSelfTestState( void );

//Wet Self test
static void setModePreGenWetSelfStateTransition( DD_WET_SELF_TEST_STATE_T state );
static void execWetSelfTest( void );
static DD_WET_SELF_TEST_STATE_T handleNegativeDeaerationPressureCheckState( void );
static DD_WET_SELF_TEST_STATE_T handlePositiveDeaerationPressureCheckState( void );

/*********************************************************************//**
 * @brief
 * The initPreGenDialysateMode function initializes the Pre-Generation
 * Dialysate Mode unit.
 * @details \b Inputs : none
 * @details \b Outputs: Pre-Gen Dialysate mode unit initialized
 * @return none
 *************************************************************************/
void initPreGenDialysateMode( void )
{
    preGenDialysateState                            = DD_PRE_GEN_DIALYSATE_HYD_CHAMBER_FILL_CHECK;
    wetSelfTestState                                = DD_WET_SELF_TEST_START;
    hydChamberPressureCheckStartTimeMS              = 0;
    pressureCheckPersistanceStartTimeMS             = 0;
    pendingStartDDGenDialRequest                    = FALSE;
    pendingStopDDPreGenDialRequest                  = FALSE;
    preGenDialysateModePublishInterval.data         = PRE_GEN_DIALYSATE_DATA_PUB_INTERVAL;
    preGenDialysateModePublishInterval.ovData       = PRE_GEN_DIALYSATE_DATA_PUB_INTERVAL;
    preGenDialysateModePublishInterval.ovInitData   = 0;
    preGenDialysateModePublishInterval.override     = OVERRIDE_RESET;
}

/*********************************************************************//**
 * @brief
 * The transitionToPreGenDialysateMode function prepares for transition 
 * to Pre-Gen Dialysate mode from standby mode.
 * @details \b Inputs: none
 * @details \b Outputs: none
 * @return initial state
 *************************************************************************/
U32 transitionToPreGenDialysateMode( void )
{
    initPreGenDialysateMode();
    deenergizeActuators( PARK_CONC_PUMPS );

    setCurrentSubState( NO_SUB_STATE );

    return preGenDialysateState;
}

/*********************************************************************//**
 * @brief
 * The execPreGenDialysateMode function executes the Pre-Gen Dialysate mode
 * state machine.
 * @details \b Inputs: preGenDialysateState
 * @details \b Outputs: Pre-Gen Dialysate mode state machine executed
 * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when wrong pre gen dialysate
 * state invoked
 * @return current state of Pre-Gen Dialysate Mode
 *************************************************************************/
U32 execPreGenDialysateMode( void )
{
    //Manage Inlet water control
    hydChamberWaterInletControl();

    //TODO: To be placed in correct states once states defined.
    if ( TRUE == pendingStartDDGenDialRequest )
    {
        pendingStartDDGenDialRequest = FALSE;
        requestNewOperationMode( DD_MODE_GEND );
    }
    //TODO: Transition to post gen dialysate if concentrate priming has been started
    else if ( TRUE == pendingStopDDPreGenDialRequest )
    {
        pendingStopDDPreGenDialRequest = FALSE;
        requestNewOperationMode( DD_MODE_STAN );
    }
    else
    {
        // execute current pre-gen dialysate state
        switch ( preGenDialysateState )
        {
            case DD_PRE_GEN_DIALYSATE_HYD_CHAMBER_FILL_CHECK:
                preGenDialysateState = handlePreGenDialysateFillCompleteCheckState();
                break;

            case DD_PRE_GEN_WET_SELF_TEST:
                preGenDialysateState = handlePreGenWetSelfTestState();
                break;

            case DD_PRE_GEN_DIALYSATE_WAIT_FOR_GEND:
                // TODO : handle wait for Gen dialysate
                break;

            default:
                SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_PRE_GEND_MODE_INVALID_EXEC_STATE, preGenDialysateState )
                break;
        }
    }

    publishPreGenDialysateState();

    return preGenDialysateState;
}

/*********************************************************************//**
 * @brief
 * The getCurrentPreGenDialysateState function returns the current state 
 * of the Pre-Gen Dialysate mode.
 * @details \b Inputs: preGenDialysateState
 * @details \b Outputs: none
 * @return current state of PreGenDialysate mode
 *************************************************************************/
DD_PRE_GEN_DIALYSATE_STATE_T getCurrentPreGenDialysateState( void )
{
    return preGenDialysateState;
}

/*********************************************************************//**
 * @brief
 * The requestDDGenDialStart function handles an TD request to start
 * generation dialysis mode.
 * @details \b Inputs: Pre generation dailysate state
 * @details \b Outputs: pendingStartDDGenDialRequest
 * @return TRUE if request accepted, FALSE if not.
 *************************************************************************/
BOOL requestDDGenDialStart( void )
{
    BOOL result = FALSE;

    if ( DD_PRE_GEN_DIALYSATE_WAIT_FOR_GEND == preGenDialysateState )
    {
        result                              = TRUE;
        pendingStartDDGenDialRequest        = TRUE;
    }

    return result;
}

/*********************************************************************//**
 * @brief
 * The requestDDPreGenStop function handles an TD request to stop
 * pre-generation dialysis mode.
 * @details \b Inputs: Pre generation dialysate mode / state
 * @details \b Outputs: pendingStopDDPreGenDialRequest
 * @return TRUE if request accepted, FALSE if not.
 *************************************************************************/
BOOL requestDDPreGenStop( void )
{
    BOOL status = FALSE;

    if ( DD_MODE_PREG == getCurrentOperationMode() )
    {
        pendingStopDDPreGenDialRequest = TRUE;
        status = TRUE;
    }

    return status;
}

/*********************************************************************//**
 * @brief
 * The handlePreGenDialysateFillCompleteCheckState function checks the
 * hydrochamber fill and transition to next state.
 * @details \b Inputs: state
 * @details \b Outputs: none
 * @return current state of PreGenDialysate mode
 *************************************************************************/
static DD_PRE_GEN_DIALYSATE_STATE_T handlePreGenDialysateFillCompleteCheckState( void )
{
    //TODO: define hydroblock fill complete process
    DD_PRE_GEN_DIALYSATE_STATE_T state  = DD_PRE_GEN_WET_SELF_TEST;

    return state;
}

/*********************************************************************//**
 * @brief
 * The handlePreGenWetSelfTestState function executes the series of self
 * tests with the conecentrates and dialysate.
 * @details \b Inputs: state
 * @details \b Outputs: none
 * @return current state of PreGenDialysate mode
 *************************************************************************/
static DD_PRE_GEN_DIALYSATE_STATE_T handlePreGenWetSelfTestState( void )
{
    //TODO: Change to wet self test state later
    DD_PRE_GEN_DIALYSATE_STATE_T state  = DD_PRE_GEN_DIALYSATE_WAIT_FOR_GEND;

    //execWetSelfTest();

    return state;
}

/*********************************************************************//**
 * @brief
 * The setModePreGenWetSelfStateTransition function sets the actuators and variables
 * for the state transition in pre-gen WetSlef test mode.
 * @details Inputs: Valve states, Pump speed
 * @details Outputs: Actuate valves, pumps as desired.
 * @param state pre gen wet self test state enum
 * @return none
 *************************************************************************/
static void setModePreGenWetSelfStateTransition( DD_WET_SELF_TEST_STATE_T state )
{
    // Execute on running state
    switch( state )
    {
        case DD_WET_SELF_TEST_START:
            // DO nothing
            break;

        case DD_WET_SELF_TEST_NEGATIVE_DEAERATION_PRES_CHECK:
            //Make sure Water Inlet Valve is open
            setValveState( M4_VALV, VALVE_STATE_OPEN );

            // Start timer for hyd chamber negative pressure check state
            hydChamberPressureCheckStartTimeMS = getMSTimerCount();
            // Start D12/Degassing pump - closed loop control
            setDialysatePumpTargetRPM( D12_PUMP, FRESH_DIAL_PUMP_INITIAL_RPM, FALSE );
            break;

        case DD_WET_SELF_TEST_POSITIVE_DEAERATION_PRES_CHECK:
            // TODO : lists the valves/pumps state
            break;

        case DD_WET_SELF_TEST_SPENT_DIAL_PRES_CHECK:
            // TODO : lists the valves/pumps state
            break;

        case DD_WET_SELF_TEST_BAL_CHAMBER_VALV_LEAK_CHECK:
            // TODO : lists the valves/pumps state
            break;

        case DD_WET_SELF_TEST_DIAL_FLOW_PATH_LEAK_CHECK:
            // TODO : lists the valves/pumps state
            break;

        case DD_WET_SELF_TEST_UF_PRES_DROP_CHECK:
            // TODO : lists the valves/pumps state
            break;

        case DD_WET_SELF_TEST_BLOOD_LEAK_CHECK:
            // TODO : lists the valves/pumps state
            break;

        case DD_WET_SELF_TEST_BAL_CHAMBER_MEMBRANE_INTEGRITY_CHECK:
            // TODO : lists the valves/pumps state
            break;

        case DD_WET_SELF_TEST_LEVEL_SENSOR_CHECK:
            //TODO : define actuators states
            break;

        case DD_WET_SELF_TEST_PAUSE:
            //TODO : define actuators states
            break;

        default:
            SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_PRE_GEND_WET_SELF_TEST_INVALID_EXEC_STATE1, state )
            break;
    }
}

/*********************************************************************//**
 * @brief
 * The execWetSelfTest function executes the pregen mode wet self test state machine.
 * @details \b Inputs: wetSelfTestState
 * @details \b Outputs: Wet self test state machine executed
 * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when wrong pre gen wet self test
 * state invoked.
 * @return current wet self state.
 *************************************************************************/
static void execWetSelfTest( void )
{
    DD_WET_SELF_TEST_STATE_T priorSubState = wetSelfTestState;

    // execute current Wet self test state
    switch ( wetSelfTestState )
    {
        case DD_WET_SELF_TEST_START:
            setModePreGenWetSelfStateTransition( DD_WET_SELF_TEST_NEGATIVE_DEAERATION_PRES_CHECK );
            wetSelfTestState = DD_WET_SELF_TEST_NEGATIVE_DEAERATION_PRES_CHECK;
            break;

        case DD_WET_SELF_TEST_NEGATIVE_DEAERATION_PRES_CHECK:
            wetSelfTestState = handleNegativeDeaerationPressureCheckState();
            break;

        case DD_WET_SELF_TEST_POSITIVE_DEAERATION_PRES_CHECK:
            wetSelfTestState = handlePositiveDeaerationPressureCheckState();
            break;

        case DD_WET_SELF_TEST_PAUSE:
             //TODO : define state
             break;

        default:
            SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_PRE_GEND_WET_SELF_TEST_INVALID_EXEC_STATE, wetSelfTestState )
            wetSelfTestState = DD_WET_SELF_TEST_NEGATIVE_DEAERATION_PRES_CHECK;
            break;
    }

    if ( priorSubState != wetSelfTestState )
    {
        setCurrentSubState( (U32)wetSelfTestState );
        //SEND_EVENT_WITH_2_U32_DATA( DD_EVENT_SUB_STATE_CHANGE, priorSubState, wetSelfTestState );
    }

    //TODO: Publish wet self test status
    //publishWetSelfTestData();
}

/*********************************************************************//**
 * @brief
 * The handleNegativeDeaerationPressureCheckState function checks the
 * negative deaeration pressure check range and transition to next state.
 * @details \b Inputs: state
 * @details \b Outputs: none
 * @return current state of Wet Self test
 *************************************************************************/
static DD_WET_SELF_TEST_STATE_T handleNegativeDeaerationPressureCheckState( void )
{
    DD_WET_SELF_TEST_STATE_T state  = DD_WET_SELF_TEST_NEGATIVE_DEAERATION_PRES_CHECK;
    F32 hydPressure                 = getFilteredPressure( D9_PRES );
    // For Degassing close loop pump control, the calculated negative pressure added up with pressure adjustment factor
    // to drive more negative pressure.Remove the pressure adjustment factor for actual pressure check.
    F32 targetPressure              = getDialysatePumpTargetPressure( D12_PUMP ) - DEGAS_PUMP_TARGET_PRES_ADJ_THRESHOLD;

    if ( hydPressure <= targetPressure )
    {
        if ( 0 == pressureCheckPersistanceStartTimeMS )
        {
            pressureCheckPersistanceStartTimeMS = getMSTimerCount();
        }
        else if ( TRUE == didTimeout( pressureCheckPersistanceStartTimeMS, NEG_PRES_PERSISTENCE_TIME_MS ) )
        {
            pressureCheckPersistanceStartTimeMS = 0;
            state                               = DD_WET_SELF_TEST_POSITIVE_DEAERATION_PRES_CHECK;
            setModePreGenWetSelfStateTransition ( state );
        }
    }
    else if ( TRUE == didTimeout( hydChamberPressureCheckStartTimeMS, HYD_CHAMBER_PRES_CHECK_TIME_OUT ) )
    {
        // time out alarm and pause the self test
        SET_ALARM_WITH_1_F32_DATA( ALARM_ID_DD_GEND_HYD_CHAMBER_PRESS_OUT_OF_RANGE, hydPressure );
        state = DD_WET_SELF_TEST_PAUSE;
        setModePreGenWetSelfStateTransition ( state );
    }

    return state;
}

/*********************************************************************//**
 * @brief
 * The handlePositiveDeaerationPressureCheckState function checks the
 * postive deaeration pressure check range and transition to next state.
 * @details \b Inputs: state
 * @details \b Outputs: none
 * @return current state of Wet Self test
 *************************************************************************/
static DD_WET_SELF_TEST_STATE_T handlePositiveDeaerationPressureCheckState( void )
{
    //TODO: define pressure check
    DD_WET_SELF_TEST_STATE_T state  = DD_WET_SELF_TEST_POSITIVE_DEAERATION_PRES_CHECK;

    return state;
}

/*********************************************************************//**
 * @brief
 * The publishPreGenDialysateState function publishes Pre-Generation dialysate
 * mode data.
 * @details \b Inputs: preGenDialysatePublishTimerCounter, preGenDialysateModePublishInterval
 * @details \b Outputs: preGenDialysatePublishTimerCounter
 * @details \b Message \Sent: MSG_ID_DD_PRE_GEN_DIALYSATE_STATE_DATA to publish the
 * pre generate dialysate mode data.
 * @return none
 *************************************************************************/
static void publishPreGenDialysateState( void )
{
    // publish data at periodic interval
    if ( ++preGenDialysatePublishTimerCounter >= getU32OverrideValue( &preGenDialysateModePublishInterval ) )
    {
        PRE_GEN_DIALYSATE_STATE_DATA_T preGenDialysateData;

        preGenDialysateData.preGenDialysateExecState      = preGenDialysateState;

        broadcastData( MSG_ID_DD_PRE_GEN_DIALYSATE_STATE_DATA, COMM_BUFFER_OUT_CAN_DD_BROADCAST, (U08*)&preGenDialysateData, sizeof( PRE_GEN_DIALYSATE_STATE_DATA_T ) );
        preGenDialysatePublishTimerCounter = 0;
    }
}


/*************************************************************************
 *                       TEST SUPPORT FUNCTIONS
 *************************************************************************/


/*********************************************************************//**
 * @brief
 * The testDDPreGenDialysateDataPublishIntervalOverride function overrides the
 * DD pre generate dialysate mode data publish interval.
 * @details \b Inputs: preGenDialysateModePublishInterval
 * @details \b Outputs: preGenDialysateModePublishInterval
 * @param Override message from Dialin which includes the interval
 * (in ms) to override the DD pre generate dialysate data publish interval to.
 * @return TRUE if override successful, FALSE if not
 *************************************************************************/
BOOL testDDPreGenDialysateDataPublishIntervalOverride( MESSAGE_T *message )
{
    BOOL result = u32BroadcastIntervalOverride( message, &preGenDialysateModePublishInterval, TASK_GENERAL_INTERVAL );

    return result;
}

/**@}*/