/**************************************************************************
*
* 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
* @date    (last)      22-Aug-2024
*
* @author  (original)  Sean
* @date    (original)  22-Aug-2024
*
***************************************************************************/

#include "FpgaTD.h"
#include "Messaging.h"
#include "PersistentAlarm.h"
#include "PressureCommon.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.

// ********** 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).
static OVERRIDE_U32_T lastPressureErrorCounter[ NUM_OF_PRESSURE_SENSORS ];                  ///< Last pressure sensor error 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 )
{
    U32 i;

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

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

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

        lastPressureErrorCounter[ i ].data = 0;
        lastPressureErrorCounter[ i ].ovData = 0;
        lastPressureErrorCounter[ i ].ovInitData = 0;
        lastPressureErrorCounter[ i ].override = OVERRIDE_RESET;
    }

    // Initialize the FPGA persistent alarms
    initFPGAPersistentAlarm( FPGA_PERS_ERROR_ARTERIAL_PRESSURE_SENSOR, ALARM_ID_TD_ARTERIAL_SENSOR_TIMEOUT_FAULT,
                             PRES_SENSORS_COUNT_ERROR_TIMEOUT_MS, PRES_SENSORS_COUNT_ERROR_TIMEOUT_MS );
    initFPGAPersistentAlarm( FPGA_PERS_ERROR_VENOUS_PRESSURE_SESNOR, ALARM_ID_TD_VENOUS_SENSOR_TIMEOUT_FAULT,
                             PRES_SENSORS_COUNT_ERROR_TIMEOUT_MS, PRES_SENSORS_COUNT_ERROR_TIMEOUT_MS );
}

/*********************************************************************//**
 * @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: none
 * @return none
 *************************************************************************/
void readPressureSensors( void )
{
    // Update and convert raw pressures to mmHg
    currentPressureReadings[ PRESSURE_SENSOR_ARTERIAL ].data = convertPressureReading2mmHg( getPBAPressure() );
    currentPressureReadings[ PRESSURE_SENSOR_VENOUS ].data   = convertPressureReading2mmHg( getPBOPressure() );

    // Update and convert raw pressure sensor temperatures to deg C
    currentPresTempReadings[ PRESSURE_SENSOR_ARTERIAL ].data = convertPressureTempReading2DegC( getPBATemperature() );
    currentPresTempReadings[ PRESSURE_SENSOR_VENOUS ].data = convertPressureTempReading2DegC( getPBOTemperature() );

    // Update read and error counters for each pressure sensor
    lastPressureReadCounter[ PRESSURE_SENSOR_ARTERIAL ].data = (U32)getPBAReadCounter();
    lastPressureReadCounter[ PRESSURE_SENSOR_VENOUS ].data = (U32)getPBOReadCounter();
    lastPressureErrorCounter[ PRESSURE_SENSOR_ARTERIAL ].data = (U32)getPBAErrorCounter();
    lastPressureErrorCounter[ PRESSURE_SENSOR_VENOUS ].data = (U32)getPBAErrorCounter();

    // Monitor pressure sensor health
    checkPressureSensors();
}

/*********************************************************************//**
 * @brief
 * The checkPressureSensors function checks the read and error counters for
 * each pressure sensor.
 * @details \b Alarm: ALARM_ID_TD_ARTERIAL_SENSOR_TIMEOUT_FAULT if the
 * arterial pressure sensor is not able to be read.
 * @details \b Alarm: ALARM_ID_TD_VENOUS_SENSOR_TIMEOUT_FAULT if the
 * venous pressure sensor is not able to be read.
 * @details \b Inputs: lastPressureReadCounter, lastPressureErrorCounter
 * @details \b Outputs: none
 * @return none
 *************************************************************************/
static void checkPressureSensors( void )
{
    checkFPGAPersistentAlarms( FPGA_PERS_ERROR_ARTERIAL_PRESSURE_SENSOR, getPressureSensorReadCount( PRESSURE_SENSOR_ARTERIAL ) );
    checkFPGAPersistentAlarms( FPGA_PERS_ERROR_VENOUS_PRESSURE_SESNOR, getPressureSensorReadCount( PRESSURE_SENSOR_VENOUS ) );
    checkFPGAPersistentErrorCountAlarm( FPGA_PERS_ERROR_ARTERIAL_PRESSURE_SENSOR, getPressureSensorErrorCount( PRESSURE_SENSOR_ARTERIAL ) );
    checkFPGAPersistentErrorCountAlarm( FPGA_PERS_ERROR_VENOUS_PRESSURE_SESNOR, getPressureSensorErrorCount( PRESSURE_SENSOR_VENOUS ) );
}

/*********************************************************************//**
 * @brief
 * The getPressure function gets the current pressure (in mmHg) for a given
 * pressure sensor.
 * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given 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_TD_SOFTWARE_FAULT, SW_FAULT_ID_PRESSURE_SENSOR_INVALID_SENSOR1, 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_TD_SOFTWARE_FAULT if given 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_TD_SOFTWARE_FAULT, SW_FAULT_ID_PRESSURE_SENSOR_INVALID_SENSOR2, sensor )
    }

    return result;
}

/*********************************************************************//**
 * @brief
 * The getPressureSensorReadCount function gets the current pressure sensor
 * read count for a given pressure sensor.
 * @details \b Alarm: ALARM_ID_TD_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_TD_SOFTWARE_FAULT, SW_FAULT_ID_PRESSURE_SENSOR_INVALID_SENSOR3, sensor )
    }

    return result;
}

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

    if ( sensor < NUM_OF_PRESSURE_SENSORS )
    {
        result = lastPressureErrorCounter[ sensor ].data;
        if ( OVERRIDE_KEY == lastPressureErrorCounter[ sensor ].override )
        {
            result = lastPressureErrorCounter[ sensor ].ovData;
        }
    }
    else
    {
        SET_ALARM_WITH_2_U32_DATA( ALARM_ID_TD_SOFTWARE_FAULT, SW_FAULT_ID_PRESSURE_SENSOR_INVALID_SENSOR4, sensor )
    }

    return result;
}


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


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

    return result;
}

/**@}*/