/**************************************************************************
*
* Copyright (c) 2024-2024 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    PressureSensor.c
*
* @author  (last)      Sean Nash
* @date    (last)      18-Nov-2024
*
* @author  (original)  Sean Nash
* @date    (original)  18-Nov-2024
*
***************************************************************************/

#include "AlarmMgmtRO.h"
#include "FpgaRO.h"
#include "Messaging.h"
#include "PersistentAlarm.h"
#include "PressureSensor.h"

/**
 *  @addtogroup PressureSensor
 *  @{
 */

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

#define PRES_SENSORS_COUNT_ERROR_TIMEOUT_MS         ( 2 * MS_PER_SECOND )                               ///< Pressure sensors read and error count timeout in milliseconds.
#define ONE_BAR_TO_MILLI_BAR                        1000                                                ///< 1 bar to milli-bar conversion.
#define COUNTS_TO_MILLI_BAR                         100                                                 ///< Counts to milli-bar conversion.
#define BAR_TO_MMHG                                 ( 750.062F )                                        ///< Conversion factor for converting bar to mmHg.
#define PRES_SENSORS_READ_ERR_MAX_CNT               0xFF                                                ///< Pressure sensor read and error max count value

#define PRES_MIN_PSI                                0.0F                                                ///< Minimum range of pressure sensors (in PSI)
#define PRES_MAX_PSI                                145.038F                                            ///< Maximum range of pressure sensors (in PSI)

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

static OVERRIDE_F32_T currentPressureReadings[ NUM_OF_PRESSURE_SENSORS ];                               ///< Current pressure sensor pressure readings (overrideable).
static OVERRIDE_F32_T currentPresTempReadings[ NUM_OF_PRESSURE_SENSORS ];                               ///< Current pressure sensor temperature readings (overrideable).
static OVERRIDE_U32_T lastPressureReadCounter[ NUM_OF_PRESSURE_SENSORS ];                               ///< Last pressure sensor read count (Overrideable).

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

//static void checkPressureSensors( void );

/*********************************************************************//**
 * @brief
 * The initPressureSensor function initializes the Pressure Sensor unit.
 * @details \b Inputs: none
 * @details \b Outputs: Pressure Sensor unit is initialized.
 * @return none
 *************************************************************************/
void initPressureSensor( void )
{
    PRESSURE_SENSORS_T sensor;

    // Initialize override structures for each pressure sensor
    for ( sensor = PRESSURE_SENSOR_FIRST; sensor < NUM_OF_PRESSURE_SENSORS; sensor++ )
    {
        currentPressureReadings[ sensor ].data = 0.0F;
        currentPressureReadings[ sensor ].ovData = 0.0F;
        currentPressureReadings[ sensor ].ovInitData = 0.0F;
        currentPressureReadings[ sensor ].override = OVERRIDE_RESET;

        currentPresTempReadings[ sensor ].data = 0.0F;
        currentPresTempReadings[ sensor ].ovData = 0.0F;
        currentPresTempReadings[ sensor ].ovInitData = 0.0F;
        currentPresTempReadings[ sensor ].override = OVERRIDE_RESET;

        lastPressureReadCounter[ sensor ].data = 0;
        lastPressureReadCounter[ sensor ].ovData = 0;
        lastPressureReadCounter[ sensor ].ovInitData = 0;
        lastPressureReadCounter[ sensor ].override = OVERRIDE_RESET;

    }

    // Initialize the FPGA persistent alarms
    // TODO - initialize persistent alarms.
}

/*********************************************************************//**
 * @brief
 * The readPressureSensors function gets the current pressure reading
 * for a all pressure sensors from the FPGA and also reads the freshness
 * and error counters to verify that the pressure sensors are being read
 * by the FPGA without issue.
 * @note This function should be called periodically to maintain fresh
 * sensor readings for all pressure sensors.
 * @details \b Inputs: FPGA
 * @details \b Outputs: currentPressureReadings[],currentPresTempReadings[],
 * lastPressureReadCounter[].
 * @return none
 *************************************************************************/
void readPressureSensors( void )
{
    // Update and convert raw pressures to mmHg
    currentPressureReadings[ M1_PRES ].data = convertPressureReading( getFPGAM1RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );
    currentPressureReadings[ M3_PRES ].data   = convertPressureReading( getFPGAM3RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );
    currentPressureReadings[ P8_PRES ].data = convertPressureReading( getFPGAP8RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );
    currentPressureReadings[ P13_PRES ].data   = convertPressureReading( getFPGAP13RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );
    currentPressureReadings[ P17_PRES ].data = convertPressureReading( getFPGAP17RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );
    currentPressureReadings[ X1_PRES ].data = convertPressureReading( getFPGAX1RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );
    currentPressureReadings[ X2_PRES ].data = convertPressureReading( getFPGAX2RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );
    currentPressureReadings[ X3_PRES ].data = convertPressureReading( getFPGAX3RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );
    currentPressureReadings[ X4_PRES ].data = convertPressureReading( getFPGAX4RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );
    currentPressureReadings[ X5_PRES ].data = convertPressureReading( getFPGAX5RawPressure(), PRES_MIN_PSI, PRES_MAX_PSI );

    // Update and convert raw pressure sensor temperatures to deg C
    currentPresTempReadings[ M1_PRES ].data = convertPressureTempReading2DegC( getFPGAM1RawTemperature() );
    currentPresTempReadings[ M3_PRES ].data   = convertPressureTempReading2DegC( getFPGAM3RawTemperature() );
    currentPresTempReadings[ P8_PRES ].data = convertPressureTempReading2DegC( getFPGAP8RawTemperature() );
    currentPresTempReadings[ P13_PRES ].data = convertPressureTempReading2DegC( getFPGAP13RawTemperature() );
    currentPresTempReadings[ P17_PRES ].data = convertPressureTempReading2DegC( getFPGAP17RawTemperature() );
    currentPresTempReadings[ X1_PRES ].data = convertPressureTempReading2DegC( getFPGAX1RawTemperature() );
    currentPresTempReadings[ X2_PRES ].data = convertPressureTempReading2DegC( getFPGAX2RawTemperature() );
    currentPresTempReadings[ X3_PRES ].data = convertPressureTempReading2DegC( getFPGAX3RawTemperature() );
    currentPresTempReadings[ X4_PRES ].data = convertPressureTempReading2DegC( getFPGAX4RawTemperature() );
    currentPresTempReadings[ X5_PRES ].data = convertPressureTempReading2DegC( getFPGAX5RawTemperature() );

    // Update read and error counters for each pressure sensor
    lastPressureReadCounter[ M1_PRES ].data = (U32)getFPGAM1ReadCount();
    lastPressureReadCounter[ M3_PRES ].data = (U32)getFPGAM3ReadCount();
    lastPressureReadCounter[ P8_PRES ].data = (U32)getFPGAP8ReadCount();
    lastPressureReadCounter[ P13_PRES ].data = (U32)getFPGAP13ReadCount();
    lastPressureReadCounter[ P17_PRES ].data = (U32)getFPGAP17ReadCount();
    lastPressureReadCounter[ X1_PRES ].data = (U32)getFPGAX1ReadCount();
    lastPressureReadCounter[ X2_PRES ].data = (U32)getFPGAX2ReadCount();
    lastPressureReadCounter[ X3_PRES ].data = (U32)getFPGAX3ReadCount();
    lastPressureReadCounter[ X4_PRES ].data = (U32)getFPGAX4ReadCount();
    lastPressureReadCounter[ X5_PRES ].data = (U32)getFPGAX5ReadCount();

//    // Monitor pressure sensor health
//    checkPressureSensors();
}

/*********************************************************************//**
 * @brief
 * The checkPressureSensors function checks the read and error counters for
 * each pressure sensor.
 * @details \b Alarm: TBD
 * @details \b Inputs: lastPressureReadCounter, lastPressureErrorCounter
 * @details \b Outputs: none
 * @return none
 *************************************************************************/
//static void checkPressureSensors( void )
//{
//    checkFPGAPersistentAlarms( FPGA_PERS_ERROR_WATER_INLET_INPUT_PRESSURE, getPressureSensorReadCount( M1_PRES ) );
//    checkFPGAPersistentAlarms( FPGA_PERS_ERROR_WATER_INLET_OUTPUT_PRESSURE, getPressureSensorReadCount( M3_PRES ) );
//
//    checkFPGAPersistentErrorCountAlarm( FPGA_PERS_ERROR_WATER_INLET_INPUT_PRESSURE, getPressureSensorErrorCount( M1_PRES ) );
//    checkFPGAPersistentErrorCountAlarm( FPGA_PERS_ERROR_WATER_INLET_OUTPUT_PRESSURE, getPressureSensorErrorCount( M3_PRES ) );
//}

/*********************************************************************//**
 * @brief
 * The getPressure function gets the current pressure (in mmHg) for a given
 * pressure sensor.
 * @details \b Alarm: ALARM_ID_RO_SOFTWARE_FAULT if given pressure sensor is invalid.
 * @details \b Inputs: currentPressureReadings
 * @details \b Outputs: none
 * @param sensor ID of pressure sensor to get pressure reading for.
 * @return The current pressure (in mmHg) of the given pressure sensor.
 *************************************************************************/
F32 getPressure( PRESSURE_SENSORS_T sensor )
{
    F32 result = 0.0F;

    if ( sensor < NUM_OF_PRESSURE_SENSORS )
    {
        result = currentPressureReadings[ sensor ].data;
        if ( OVERRIDE_KEY == currentPressureReadings[ sensor ].override )
        {
            result = currentPressureReadings[ sensor ].ovData;
        }
    }
    else
    {
        SET_ALARM_WITH_2_U32_DATA( ALARM_ID_FP_SOFTWARE_FAULT, SW_FAULT_ID_PRESSURE_SENSOR_INVALID_SENSOR1, (U32)sensor )
    }

    return result;
}

/*********************************************************************//**
 * @brief
 * The getPressureSensorTemperature function gets the current pressure sensor
 * temperature (in deg C) for a given pressure sensor.
 * @details \b Alarm: ALARM_ID_RO_SOFTWARE_FAULT if given pressure sensor is invalid.
 * @details \b Inputs: currentPresTempReadings
 * @details \b Outputs: none
 * @param sensor ID of pressure sensor to get temperature reading for.
 * @return The current pressure sensor temperature (in deg C) of the given pressure sensor.
 *************************************************************************/
F32 getPressureSensorTemperature( PRESSURE_SENSORS_T sensor )
{
    F32 result = 0.0F;

    if ( sensor < NUM_OF_PRESSURE_SENSORS )
    {
        result = currentPresTempReadings[ sensor ].data;
        if ( OVERRIDE_KEY == currentPresTempReadings[ sensor ].override )
        {
            result = currentPresTempReadings[ sensor ].ovData;
        }
    }
    else
    {
        SET_ALARM_WITH_2_U32_DATA( ALARM_ID_FP_SOFTWARE_FAULT, SW_FAULT_ID_PRESSURE_SENSOR_INVALID_SENSOR2, (U32)sensor )
    }

    return result;
}

/*********************************************************************//**
 * @brief
 * The getPressureSensorReadCount function gets the current pressure sensor
 * read count for a given pressure sensor.
 * @details \b Alarm: ALARM_ID_RO_SOFTWARE_FAULT if given sensor is invalid.
 * @details \b Inputs: lastPressureReadCounter
 * @details \b Outputs: none
 * @param sensor ID of pressure sensor to get read count for.
 * @return The current pressure sensor read count of a given pressure sensor.
 *************************************************************************/
U32 getPressureSensorReadCount( PRESSURE_SENSORS_T sensor )
{
    U32 result = 0;

    if ( sensor < NUM_OF_PRESSURE_SENSORS )
    {
        result = lastPressureReadCounter[ sensor ].data;
        if ( OVERRIDE_KEY == lastPressureReadCounter[ sensor ].override )
        {
            result = lastPressureReadCounter[ sensor ].ovData;
        }
    }
    else
    {
        SET_ALARM_WITH_2_U32_DATA( ALARM_ID_FP_SOFTWARE_FAULT, SW_FAULT_ID_PRESSURE_SENSOR_INVALID_SENSOR3, sensor )
    }

    return result;
}


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


/*********************************************************************//**
 * @brief
 * The testPressureSensorReadingsOverride function overrides the value of
 * the specified pressure sensor with a given value.
 * @details \b Inputs: none
 * @details \b Outputs: currentPressureReadings[]
 * @param message Override message from Dialin which includes an sensor
 * ID and override value of the pressure sensor.
 * @return TRUE if override successful, FALSE if not
 *************************************************************************/
BOOL testPressureSensorReadingsOverride( MESSAGE_T *message )
{
    BOOL result = f32ArrayOverride( message, &currentPressureReadings[0], NUM_OF_PRESSURE_SENSORS - 1 );

    return result;
}

/*********************************************************************//**
 * @brief
 * The testPressureSensorTemperatureReadingsOverride function overrides the
 * value of the specified pressure sensor temperature with a given value.
 * @details \b Inputs: none
 * @details \b Outputs: currentPresTempReadings[]
 * @param message Override message from Dialin which includes an sensor
 * ID and override value of the pressure sensor temperature.
 * @return TRUE if override successful, FALSE if not
 *************************************************************************/
BOOL testPressureSensorTemperatureReadingsOverride( MESSAGE_T *message )
{
    BOOL result = f32ArrayOverride( message, &currentPresTempReadings[0], NUM_OF_PRESSURE_SENSORS - 1 );

    return result;
}

/*********************************************************************//**
 * @brief
 * The testPressureSensorReadCounterOverride function overrides the value
 * of the specified pressure sensor read counter with a given value.
 * @details \b Inputs: none
 * @details \b Outputs: lastPressureReadCounter[]
 * @param message Override message from Dialin which includes an sensor
 * ID and override value of the pressure sensor read counter.
 * @return TRUE if override successful, FALSE if not
 *************************************************************************/
BOOL testPressureSensorReadCounterOverride( MESSAGE_T *message )
{
    BOOL result = u32ArrayOverride( message, &lastPressureReadCounter[0], NUM_OF_PRESSURE_SENSORS - 1, 0, PRES_SENSORS_READ_ERR_MAX_CNT );

    return result;
}

/**@}*/