P017_41_KG3_RTD.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P017_41_KG3_RTD.h
//! @brief      KG3 RTD input board P017.41 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_41_KG3_RTD/P017_41_KG3_RTD.h $
//!             $Revision: 2457 $
//!             $Date: 2021-03-11 11:54:01 +0500 (Do, 11 Mrz 2021) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// 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 ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief KG3 RTD P017.41 board class
//------------------------------------------------------------------------------
 
class TP017_41_KG3_RTD : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, 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_RTD_Control;    //!< 0x02 : Control register
        U16 u16_RTD_Status;     //!< 0x02 : Status register
      };
 
      U16 u16_RTD_Data;         //!< 0x03 : Data register
 
    } TP017_41_KG3_RTD_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
    
    // Constructor and destructor
    TP017_41_KG3_RTD(); //!< Class constructor method
    virtual ~TP017_41_KG3_RTD(); //!< Class destructor method
 
    VOID Map( TP017_41_KG3_RTD_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
 
    // 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;
 
    
    // 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;
 
    union
    {
      U32 u32_Status;
      struct
      {
        U32 bool_FPGA_Timeout_Fault_Channel_1:1;
        U32 bool_RTD_Hardware_Fault_Channel_1:1;
        U32 bool_FPGA_Timeout_Fault_Channel_2:1;
        U32 bool_RTD_Hardware_Fault_Channel_2:1;
        U32 bool_FPGA_Timeout_Fault_Channel_3:1;
        U32 bool_RTD_Hardware_Fault_Channel_3:1;
        U32 bool_FPGA_Timeout_Fault_Channel_4:1;
        U32 bool_RTD_Hardware_Fault_Channel_4:1;
        U32 :24;
      } u32_Status_Bits;
    };
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
    
    // Hardware communication related methods 
    BOOL RTD_Wait(); //!< Wait for RTD ready
    BOOL RTD_Read( U16 u16_Command, U16 *u16_Data ); //!< Read register value
    BOOL RTD_Write( U16 u16_Command, U16 u16_Data ); //!< Write register value
  
    // Channel configuration related methods
    BOOL Configure_Channel( U16 u16_Command, U16 u16_Data ); //!< RTD chip configuration method
 
    // Temperature measurement related methods
    BOOL Get_Temperature_Channel_1();
    BOOL Get_Temperature_Channel_2();
    BOOL Get_Temperature_Channel_3();
    BOOL Get_Temperature_Channel_4();
    
    // Calculation related methods 
    F32 Calculate_Resistance( U16 u16_ADC_Value ); //!< Calculate resistance from ADC value
 
    // FPGA memory mapped registers
    volatile TP017_41_KG3_RTD_Registers *struct_Registers; //!< FPGA memory mapped registers
 
    // Relability statistical data
    U32 u32_RTD_Timeout_Error_Count;
 
    U32 u32_RTD_Temperature_Read_Count_1;
    U32 u32_RTD_Temperature_Read_Count_2;
    U32 u32_RTD_Temperature_Read_Count_3;
    U32 u32_RTD_Temperature_Read_Count_4;
 
    U32 u32_RTD_Temperature_Read_Success_Count_1;
    U32 u32_RTD_Temperature_Read_Success_Count_2;
    U32 u32_RTD_Temperature_Read_Success_Count_3;
    U32 u32_RTD_Temperature_Read_Success_Count_4;
 
    U32 u32_RTD_Hardware_Error_Count_1;
    U32 u32_RTD_Hardware_Error_Count_2;
    U32 u32_RTD_Hardware_Error_Count_3;
    U32 u32_RTD_Hardware_Error_Count_4;
    
    U16 u16_RTD_Status_1;
    U16 u16_RTD_Status_2;
    U16 u16_RTD_Status_3;
    U16 u16_RTD_Status_4;
 
    F32 f32_RTD_Temperature_1;
    F32 f32_RTD_Temperature_2;
    F32 f32_RTD_Temperature_3;
    F32 f32_RTD_Temperature_4;
  
    volatile U32 u32_Dummy_Counter; //! ANVILEX: To remove
 
};
  
//------------------------------------------------------------------------------
// End of file 
//------------------------------------------------------------------------------