KG3_RTD2_T1.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       KG3_RTD2_T1.h
//! @brief      KG3 RTD2 input board P017.64 V1 T1 hardware driver header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P017_64_KG3_RTD2/KG3_RTD2_T1.h $
//!             $Revision: 2871 $
//!             $Date: 2021-09-17 14:54:52 +0500 (Fr, 17 Sep 2021) $
//!             $Author: ggavrituhin $
//------------------------------------------------------------------------------
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Function_Block_Base.h"
#include "PRT_Sensor.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief KG2 RTD2 T0 (DUMMY) board class
//------------------------------------------------------------------------------
 
class TKG3_RTD2_T0 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public type declarations
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TKG3_RTD2_T0(); //!< Class constructor method
    virtual ~TKG3_RTD2_T0(); //!< Class destructor method
 
    VOID Map();
    virtual VOID Init(); //!< Functional block initialisation method
    virtual VOID Execute(); //!< Functional block execution method
    virtual VOID Send_Information( TProtocol_Base *object_Protocol ); //!< Send information method
 
    //--------------------------------------------------------------------------
    // Block parameters
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_1;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_2;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_3;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_4;
 
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_1;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_2;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_3;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_4;
 
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_1;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_2;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_3;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_4;
 
    TBlock_Output_Connector object_f32_Temperature_Channel_1;
    TBlock_Output_Connector object_f32_Temperature_Channel_2;
    TBlock_Output_Connector object_f32_Temperature_Channel_3;
    TBlock_Output_Connector object_f32_Temperature_Channel_4;
 
    //--------------------------------------------------------------------------
    // Debug interface
    //--------------------------------------------------------------------------
 
    // Status ???
    union
    {
      U32 u32_Status;
      struct
      {
        U32 bool_FPGA_Timeout_Fault_Channel_1:1;
        U32 bool_Hardware_Fault_Channel_1:1;
        U32 bool_Sensor_Open_Channel_1:1;
        U32 bool_Sensor_Short_Channel_1:1;
        U32 bool_FPGA_Timeout_Fault_Channel_2:1;
        U32 bool_Hardware_Fault_Channel_2:1;
        U32 bool_Sensor_Open_Channel_2:1;
        U32 bool_Sensor_Short_Channel_2:1;
        U32 bool_FPGA_Timeout_Fault_Channel_3:1;
        U32 bool_Hardware_Fault_Channel_3:1;
        U32 bool_Sensor_Open_Channel_3:1;
        U32 bool_Sensor_Short_Channel_3:1;
        U32 bool_FPGA_Timeout_Fault_Channel_4:1;
        U32 bool_Hardware_Fault_Channel_4:1;
        U32 bool_Sensor_Open_Channel_4:1;
        U32 bool_Sensor_Short_Channel_4:1;
        U32 :16;
      } u32_Status_Bits;
    };
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    F32 f32_Sensor_Temperature_1; //!< Channel 1, sensor temperature
    F32 f32_Sensor_Temperature_2; //!< Channel 2, sensor temperature
    F32 f32_Sensor_Temperature_3; //!< Channel 3, sensor temperature
    F32 f32_Sensor_Temperature_4; //!< Channel 4, sensor temperature
 
};
 
//------------------------------------------------------------------------------
//! @brief KG2 RTD2 T1 (P017.64 V1 T1) board class
//------------------------------------------------------------------------------
 
class TKG3_RTD2_T1 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public type declarations
    //--------------------------------------------------------------------------
 
    // Register structure for generic access
    typedef struct
    {
 
      // Unit identification registers
      U16 u16_Unit_ID_L;        //!< 0x00 : Module identification register
      U16 u16_Unit_ID_H;        //!< 0x01 : Module identification register
 
      union
      {
        U16 u16_Control_Register;  //!< 0x02 Control register
        U16 u16_Status_Register;   //!< 0x02 Status register
      };
 
      // Analog value registers
      U16 u16_ADC_Data_1;   //!< 0x03 ADC channel 1 data register as U16 value
      U16 u16_ADC_Data_2;   //!< 0x04 ADC channel 2 data register as U16 value
      U16 u16_ADC_Data_3;   //!< 0x05 ADC channel 3 data register as U16 value
      U16 u16_ADC_Data_4;   //!< 0x06 ADC channel 4 data register as U16 value
      U16 u16_ADC_Filtered_Data_1; //!< 0x07 ADC channel 1 filtered data register as U16 value
      U16 u16_ADC_Filtered_Data_2; //!< 0x08 ADC channel 2 filtered data register as U16 value
      U16 u16_ADC_Filtered_Data_3; //!< 0x09 ADC channel 3 filtered data register as U16 value
      U16 u16_ADC_Filtered_Data_4; //!< 0x0A ADC channel 4 filtered data register as U16 value
 
    } TKG3_RTD2_T1_Registers;
 
    // Constructor and destructor
    TKG3_RTD2_T1(); //!< Class constructor method
    virtual ~TKG3_RTD2_T1(); //!< Class destructor method
 
    VOID Map( TKG3_RTD2_T1_Registers *struct_Registers_Base_Address );
    virtual VOID Init(); //!< Functional block initialisation method
    virtual VOID Execute(); //!< Functional block execution method
    virtual VOID Send_Information( TProtocol_Base *object_Protocol ); //!< Send information method
    
    U32 Get_Status(); //!< Return block status method
 
    //--------------------------------------------------------------------------
    // Block parameters
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_1;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_2;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_3;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_4;
 
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_1;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_2;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_3;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_4;
 
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_1;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_2;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_3;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_4;
 
    TBlock_Output_Connector object_f32_Temperature_Channel_1;
    TBlock_Output_Connector object_f32_Temperature_Channel_2;
    TBlock_Output_Connector object_f32_Temperature_Channel_3;
    TBlock_Output_Connector object_f32_Temperature_Channel_4;
 
    TBlock_Output_Connector object_bool_FPGA_Timeout_Fault_Channel_1;
    TBlock_Output_Connector object_bool_Hardware_Fault_Channel_1;
    TBlock_Output_Connector object_bool_Sensor_Open_Channel_1;
    TBlock_Output_Connector object_bool_Sensor_Short_Channel_1;
 
    TBlock_Output_Connector object_bool_FPGA_Timeout_Fault_Channel_2;
    TBlock_Output_Connector object_bool_Hardware_Fault_Channel_2;
    TBlock_Output_Connector object_bool_Sensor_Open_Channel_2;
    TBlock_Output_Connector object_bool_Sensor_Short_Channel_2;
 
    TBlock_Output_Connector object_bool_FPGA_Timeout_Fault_Channel_3;
    TBlock_Output_Connector object_bool_Hardware_Fault_Channel_3;
    TBlock_Output_Connector object_bool_Sensor_Open_Channel_3;
    TBlock_Output_Connector object_bool_Sensor_Short_Channel_3;
 
    TBlock_Output_Connector object_bool_FPGA_Timeout_Fault_Channel_4;
    TBlock_Output_Connector object_bool_Hardware_Fault_Channel_4;
    TBlock_Output_Connector object_bool_Sensor_Open_Channel_4;
    TBlock_Output_Connector object_bool_Sensor_Short_Channel_4;
 
    // Status ???
    union TStatus
    {
      U32 u32_Status;
      struct
      {
        U32 bool_FPGA_Timeout_Fault_Channel_1:1;
        U32 bool_Hardware_Fault_Channel_1:1;
        U32 bool_Sensor_Open_Channel_1:1;
        U32 bool_Sensor_Short_Channel_1:1;
        U32 bool_FPGA_Timeout_Fault_Channel_2:1;
        U32 bool_Hardware_Fault_Channel_2:1;
        U32 bool_Sensor_Open_Channel_2:1;
        U32 bool_Sensor_Short_Channel_2:1;
        U32 bool_FPGA_Timeout_Fault_Channel_3:1;
        U32 bool_Hardware_Fault_Channel_3:1;
        U32 bool_Sensor_Open_Channel_3:1;
        U32 bool_Sensor_Short_Channel_3:1;
        U32 bool_FPGA_Timeout_Fault_Channel_4:1;
        U32 bool_Hardware_Fault_Channel_4:1;
        U32 bool_Sensor_Open_Channel_4:1;
        U32 bool_Sensor_Short_Channel_4:1;
        U32 :16;
      } u32_Status_Bits;
    };
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    // FPGA memory mapped registers
    volatile TKG3_RTD2_T1_Registers *struct_Registers; //!< FPGA memory mapped registers
 
    TPRT object_PRT;
 
    U32 u32_Sensor_Valid_Data_Count_1; //!< Channel 1, sensor valid data count
    U32 u32_Sensor_Valid_Data_Count_2; //!< Channel 2, sensor valid data count
    U32 u32_Sensor_Valid_Data_Count_3; //!< Channel 3, sensor valid data count
    U32 u32_Sensor_Valid_Data_Count_4; //!< Channel 4, sensor valid data count
 
    U32 u32_Sensor_Open_Error_Count_1; //!< Channel 1, open sensor error count
    U32 u32_Sensor_Open_Error_Count_2; //!< Channel 2, open sensor error count
    U32 u32_Sensor_Open_Error_Count_3; //!< Channel 3, open sensor error count
    U32 u32_Sensor_Open_Error_Count_4; //!< Channel 4, open sensor error count
 
    U32 u32_Sensor_Short_Error_Count_1; //!< Channel 1, short sensor error count
    U32 u32_Sensor_Short_Error_Count_2; //!< Channel 2, short sensor error count
    U32 u32_Sensor_Short_Error_Count_3; //!< Channel 3, short sensor error count
    U32 u32_Sensor_Short_Error_Count_4; //!< Channel 4, short sensor error count
 
    U16 u16_ADC_Data_1; //!< Channel 1, ADC raw data
    U16 u16_ADC_Data_2; //!< Channel 2, ADC raw data
    U16 u16_ADC_Data_3; //!< Channel 3, ADC raw data
    U16 u16_ADC_Data_4; //!< Channel 4, ADC raw data
 
    F32 f32_Sensor_Resistance_1; //!< Channel 1, sensor resistance
    F32 f32_Sensor_Resistance_2; //!< Channel 2, sensor resistance
    F32 f32_Sensor_Resistance_3; //!< Channel 3, sensor resistance
    F32 f32_Sensor_Resistance_4; //!< Channel 4, sensor resistance
 
    F32 f32_Sensor_Temperature_1; //!< Channel 1, sensor temperature
    F32 f32_Sensor_Temperature_2; //!< Channel 2, sensor temperature
    F32 f32_Sensor_Temperature_3; //!< Channel 3, sensor temperature
    F32 f32_Sensor_Temperature_4; //!< Channel 4, sensor temperature
 
//    U16 u16_RTD_Status_1;
//    U16 u16_RTD_Status_2;
//    U16 u16_RTD_Status_3;
//    U16 u16_RTD_Status_4;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------