P020_12_KG3_GRTD.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P020_12_KG3_GRTD.h
//! @brief      KG3 RTD sensor emulation board P020.12 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/P020_12_KG3_GRTD/P020_12_KG3_GRTD.h $
//!             $Revision: 2850 $
//!             $Date: 2021-08-20 14:07:16 +0500 (Fr, 20 Aug 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.
//
//------------------------------------------------------------------------------
//  
// TP020_12_KG3_GRTD_T0
//   Emulation of the DIO board.
//
// TP020_12_KG3_GRTD_T1
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Functional_Block_Base.h"
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief RTD sensor emulation P020.12 board class
class TP020_12_KG3_GRTD_T0 : public TFunctional_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP020_12_KG3_GRTD_T0(); 
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TP020_12_KG3_GRTD_T0();
 
//    //!-------------------------------------------------------------------------
//    //! @brief     Hardware mapping method.
//    //! @note      None
//    //! @param     [in] *struct_Registers_Base_Address - Base adress to register structure mapping
//    //! \par       Override
//    //!            Not allowed
//    //! @attention None
//    //--------------------------------------------------------------------------
 
//    VOID Map( TP020_12_KG3_GRTD_Registers *struct_Registers_Base_Address ); //!< Map method
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init(); //!< Block initialization method
 
//    //!-------------------------------------------------------------------------
//    //! @brief     Function block execution method.
//    //! @note      None
//    //! \par       Override
//    //!            Not allowed
//    //! @attention None
//    //--------------------------------------------------------------------------
 
//    virtual VOID Execute(); //!< Block execution method
 
    
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block parameter signals
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block input signals
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_u16_Digital_Output_1;
    TBlock_Input_Connector object_u16_Digital_Output_2;
    TBlock_Input_Connector object_u16_Digital_Output_3;
    TBlock_Input_Connector object_u16_Digital_Output_4;
 
//    TBlock_Input_Connector u16_Digital_Outputs;
 
    //--------------------------------------------------------------------------
    // Function block output signals
    //--------------------------------------------------------------------------
 
  //----------------------------------------------------------------------------
  // Protected mathods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private mathods and variables
  //----------------------------------------------------------------------------
 
  private:
 
 
 
};
 
//------------------------------------------------------------------------------
 
class TP020_12_KG3_GRTD_T1 : public TFunctional_Block_Base
{
  
  //--------------------------------------------------------------------------
  // Public methods and variables
  //--------------------------------------------------------------------------
 
  public:
 
    // Register structure for digital I/O access
    typedef struct
    {
 
      // Unit identification registers
      U16 u16_Unit_ID_L;        //!< 0x00 : Module identification register
      U16 u16_Unit_ID_H;        //!< 0x01 : Module identification register
 
      // Digital inputs
      U16 u16_RTD_Data_1;       //!< 0x02 : RTD date channel 1
      U16 u16_RTD_Data_2;       //!< 0x03 : RTD date channel 2
      U16 u16_RTD_Data_3;       //!< 0x04 : RTD date channel 3
      U16 u16_RTD_Data_4;       //!< 0x05 : RTD date channel 4
 
      // Digital outputs
      U16 u16_Reserve_6;        //!< 0x06 : Reserved
      U16 u16_Reserve_7;        //!< 0x07 : Reserved
      U16 u16_Reserve_8;        //!< 0x08 : Reserved
      U16 u16_Reserve_9;        //!< 0x09 : Reserved
      U16 u16_Reserve_10;       //!< 0x0A : Reserved
      U16 u16_Reserve_11;       //!< 0x0B : Reserved
      U16 u16_Reserve_12;       //!< 0x0C : Reserved
      U16 u16_Reserve_13;       //!< 0x0D : Reserved
      U16 u16_Reserve_14;       //!< 0x0E : Reserved
      U16 u16_Reserve_15;       //!< 0x0F : Reserved
 
    } TP020_12_KG3_GRTD_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP020_12_KG3_GRTD_T1();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TP020_12_KG3_GRTD_T1(); //!< Class destructor method
 
    //!-------------------------------------------------------------------------
    //! @brief     Hardware mapping method.
    //! @note      None
    //! @param     [in] *struct_Registers_Base_Address - Base adress to register structure mapping
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TP020_12_KG3_GRTD_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
    
    U32 Get_Module_ID();
   
    //!-------------------------------------------------------------------------
    //! @brief     Send information about flow converter board driver over communication link protocol
    //! @note      This method sends information about flow converter driver over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
   // virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block input signals
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_u16_Digital_Output_1;
    TBlock_Input_Connector object_u16_Digital_Output_2;
    TBlock_Input_Connector object_u16_Digital_Output_3;
    TBlock_Input_Connector object_u16_Digital_Output_4;
 
    //--------------------------------------------------------------------------
    // Function block output signals
    //--------------------------------------------------------------------------
 
 
  //--------------------------------------------------------------------------
  // Protected mathods and variables
  //--------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private mathods and variables
  //--------------------------------------------------------------------------
 
  private:
 
    //! @brief Pointer to the memory area in FPGA address space
    volatile TP020_12_KG3_GRTD_Registers *struct_Registers;
 
};
  
//------------------------------------------------------------------------------
// End of file 
//------------------------------------------------------------------------------