P020_12_KG3_PTE.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P020_12_KG3_PTE.h
//! @brief      KG3 PTE 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_PTE/P020_12_KG3_PTE.h $
//!             $Revision: 2305 $
//!             $Date: 2020-12-25 03:00:01 +0500 (Пт, 25 дек 2020) $
//!             $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.
//
//------------------------------------------------------------------------------
//  
// TP020_12_KG3_PTE_T0
//   Emulation of the DIO board.
//
// TP020_12_KG3_PTE_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 "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
class TP020_12_KG3_PTE_T1 : public TFunction_Block_Base
{
  
  //--------------------------------------------------------------------------
  // Public defines, methods and variables
  //--------------------------------------------------------------------------
 
  public:
 
    //------------------------------------------------------------------------
    // Public defines
    //------------------------------------------------------------------------
  
    // Register structure for digital I/O access
    typedef struct
    {
 
      //! @brief 0x00 : Module identification low register
      U16 u16_Unit_ID_L;        
      
      //! @brief 0x01 : Module identification high register
      U16 u16_Unit_ID_H; 
 
      union
      {
 
        //! @brief 0x02 : PTE relay control
        //Bit 15 : Reserved
        //Bit 14 : Channel 4, realay 3 output control (RL111)
        //Bit 13 : Channel 4, realay 2 output control (RL110)
        //Bit 12 : Channel 4, realay 1 output control (RL109)
        //Bit 11 : Reserved
        //Bit 10 : Channel 3, realay 3 output control (RL108)
        //Bit 9  : Channel 3, realay 2 output control (RL107)
        //Bit 8  : Channel 3, realay 1 output control (RL106)
        //Bit 7  : Reserved
        //Bit 6  : Channel 2, realay 3 output control (RL105)
        //Bit 5  : Channel 2, realay 2 output control (RL104)
        //Bit 4  : Channel 2, realay 1 output control (RL103)
        //Bit 3  : Reserved
        //Bit 2  : Channel 1, realay 3 output control (RL102)
        //Bit 1  : Channel 1, realay 2 output control (RL101)
        //Bit 0  : Channel 1, realay 1 output control (RL100)
        U16 u16_Relay_Control;
        
        //! @brief 0x02 : PTE relay control
        //Bit 15 : Reserved
        //Bit 14 : Channel 4, realay 3 output status (RL111)
        //Bit 13 : Channel 4, realay 2 output status (RL110)
        //Bit 12 : Channel 4, realay 1 output status (RL109)
        //Bit 11 : Reserved                          
        //Bit 10 : Channel 3, realay 3 output status (RL108)
        //Bit 9  : Channel 3, realay 2 output status (RL107)
        //Bit 8  : Channel 3, realay 1 output status (RL106)
        //Bit 7  : Reserved                          
        //Bit 6  : Channel 2, realay 3 output status (RL105)
        //Bit 5  : Channel 2, realay 2 output status (RL104)
        //Bit 4  : Channel 2, realay 1 output status (RL103)
        //Bit 3  : Reserved                          
        //Bit 2  : Channel 1, realay 3 output status (RL102)
        //Bit 1  : Channel 1, realay 2 output status (RL101)
        //Bit 0  : Channel 1, realay 1 output status (RL100)
        U16 u16_Relay_Status;
      
      };
      
      //! @brief 0x03 : Set relay outputs
      U16 u16_Set_Relay_Outputs;
      
      //! @brief 0x04 : Clear relay outputs
      U16 u16_Clear_Relay_Outputs;
      
      //! @brief 0x05 : Toggle relay outputs
      U16 u16_Toggle_Relay_Outputs;
 
      //! @brief 0x06 : Reserved
      U16 u16_Reserve_6; 
 
      //! @brief 0x07 : Reserved
      U16 u16_Reserve_7;
      
      //! @brief 0x08 : Reserved
      U16 u16_Reserve_8; 
      
      //! @brief 0x09 : Reserved
      U16 u16_Reserve_9;
      
      //! @brief 0x0A : Reserved
      U16 u16_Reserve_10;
      
      //! @brief 0x0B : Reserved
      U16 u16_Reserve_11;
      
      //! @brief 0x0C : Reserved
      U16 u16_Reserve_12;
      
      //! @brief 0x0D : Reserved
      U16 u16_Reserve_13;
      
      //! @brief 0x0E : Reserved
      U16 u16_Reserve_14;
      
      //! @brief 0x0F : Reserved
      U16 u16_Reserve_15;
 
    } TP020_12_KG3_PTE_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP020_12_KG3_PTE_T1();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TP020_12_KG3_PTE_T1();
 
    //!-------------------------------------------------------------------------
    //! @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_PTE_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();
    
    //!-------------------------------------------------------------------------
    //! @brief     Send information method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    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 );
   
    //!-------------------------------------------------------------------------
    //! @brief     Check channel limit data
    //! @note      None
    //! @param     [in] u8_Channel_Index - Checked value
    //! @return    U8 - Validated value
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
   
    U8 Check_Limit_Channel_Index( U8 u8_Channel_Index );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block input signals
    //--------------------------------------------------------------------------
 
    //! @brief Channel 1
    TBlock_Input_Connector object_u8_Channel_1;
    
    //! @brief Channel 2
    TBlock_Input_Connector object_u8_Channel_2;
    
    //! @brief Channel 3
    TBlock_Input_Connector object_u8_Channel_3;
    
    //! @brief Channel 4
    TBlock_Input_Connector object_u8_Channel_4;
 
    //--------------------------------------------------------------------------
    // Function block output signals
    //--------------------------------------------------------------------------
 
  //--------------------------------------------------------------------------
  // Protected defines, mathods and variables
  //--------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, mathods and variables
  //--------------------------------------------------------------------------
 
  private:
 
    //! @brief Pointer to the memory area in FPGA address space
    volatile TP020_12_KG3_PTE_Registers *struct_Registers;
 
};
  
//------------------------------------------------------------------------------
// End of file 
//------------------------------------------------------------------------------