P017_20_KG3_FOTR.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P017_20_KG3_FOTR.h
//! @brief      KG3 fiber optic transiever board P017.20 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_20_KG3_FOTR/P017_20_KG3_FOTR.h $
//!             $Revision: 2496 $
//!             $Date: 2021-03-17 14:57:57 +0500 (Mi, 17 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief IGBT interface I/O board P012.33 V1.0 class
//------------------------------------------------------------------------------
 
class TP017_20_KG3_FOTR_T0 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables 
  //----------------------------------------------------------------------------
  
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TP017_20_KG3_FOTR_T0(); //!< Constructor method
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP017_20_KG3_FOTR_T0();
 
    //!-------------------------------------------------------------------------
    //! @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 about digital I/O baortd driver over communication link protocol
    //! @note      This method sends information about digital I/O driver over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Block input signals
    //--------------------------------------------------------------------------
    
    //! @brief TX channels operation mode
    TBlock_Input_Connector object_bool_TX_Channels_Mode; 
    
    //! @brief TX channel data
    TBlock_Input_Connector object_u16_TX_Channels_Control; 
 
    //! @brief RX channel 1 emulation data
    TBlock_Input_Connector object_bool_RX_Channel_Emulation_1;
 
    //! @brief RX channel 2 emulation data
    TBlock_Input_Connector object_bool_RX_Channel_Emulation_2;
 
    //! @brief RX channel 3 emulation data
    TBlock_Input_Connector object_bool_RX_Channel_Emulation_3;
 
    //! @brief RX channel 4 emulation data
    TBlock_Input_Connector object_bool_RX_Channel_Emulation_4;
 
    //! @brief RX channel 5 emulation data
    TBlock_Input_Connector object_bool_RX_Channel_Emulation_5;
 
    //! @brief RX channel 6 emulation data
    TBlock_Input_Connector object_bool_RX_Channel_Emulation_6;
 
    //--------------------------------------------------------------------------
    // Block output signals
    //--------------------------------------------------------------------------
 
    //! @brief RX channel status
    TBlock_Output_Connector object_u16_RX_Channels_Status; 
 
    //! @brief TX channel status
    TBlock_Output_Connector object_u16_TX_Channels_Status; 
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
  
};
 
//------------------------------------------------------------------------------
 
class TP017_20_KG3_FOTR_T1 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public type definitions
    //--------------------------------------------------------------------------
 
    // Register structure for generic access
    typedef struct
    {
 
      //! @brief 0x00 : Unit identification L read register
      U16 u16_Unit_ID_L;        
      
      //! @brief 0x01 : Unit identification H read register
      U16 u16_Unit_ID_H;        
      
      union
      {
        
        //! @brief 0x02 : Status register
        U16 u16_Status;         
        
        //! @brief 0x02 : Control register
        U16 u16_Control;    
        
      };
      
      //! @brief 0x03 : TX output data write register
      U16 u16_TX_Data;          
      
      //! @brief 0x04 : Not used
      U16 u16_Reserved_4;       
      
      //! @brief 0x05 : Not used
      U16 u16_Reserved_5;       
      
      //! @brief 0x06 : Not used
      U16 u16_Reserved_6;       
      
      //! @brief 0x07 : RX data read register
      U16 u16_RX_Data;          
      
      //! @brief 0x08 : Reserved
      U16 u16_Reserved_8;       
      
      //! @brief 0x09 : Reserved
      U16 u16_Reserved_9;       
      
      //! @brief 0x0A : Reserved
      U16 u16_Reserved_10;      
      
      //! @brief 0x0B : Not used
      U16 u16_Reserved_11;      
      
      //! @brief 0x0C : Not used
      U16 u16_Reserved_12;      
      
      //! @brief 0x0D : Not used
      U16 u16_Reserved_13;      
      
      //! @brief 0x0E : Not used
      U16 u16_Reserved_14;      
      
      //! @brief 0x0F : Not used
      U16 u16_Reserved_15;      
 
    } TP017_20_KG3_FOTR_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    TP017_20_KG3_FOTR_T1();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP017_20_KG3_FOTR_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( TP017_20_KG3_FOTR_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 about digital I/O baortd driver over communication link protocol
    //! @note      This method sends information about digital I/O driver over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
    
    //! @brief TX channels operation mode
    TBlock_Input_Connector object_bool_TX_Channels_Mode;
    
    //! @brief TX channel data
    TBlock_Input_Connector object_u16_TX_Channels_Control;
 
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
 
    //! @brief RX channel status
    TBlock_Output_Connector object_u16_RX_Channels_Status;
//    TBlock_Output_Connector object_bool_RX_Channel_1_Status;
//    TBlock_Output_Connector object_bool_RX_Channel_2_Status;
//    TBlock_Output_Connector object_bool_RX_Channel_3_Status;
//    TBlock_Output_Connector object_bool_RX_Channel_4_Status;
//    TBlock_Output_Connector object_bool_RX_Channel_5_Status;
//    TBlock_Output_Connector object_bool_RX_Channel_6_Status;
 
    //! @brief TX channel status
    TBlock_Output_Connector object_u16_TX_Channels_Status; 
//    TBlock_Output_Connector object_bool_TX_Channel_1_Status;
//    TBlock_Output_Connector object_bool_TX_Channel_2_Status;
//    TBlock_Output_Connector object_bool_TX_Channel_3_Status;
//    TBlock_Output_Connector object_bool_TX_Channel_4_Status;
//    TBlock_Output_Connector object_bool_TX_Channel_5_Status;
//    TBlock_Output_Connector object_bool_TX_Channel_6_Status;
    
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief Hardware mapped registers
    volatile TP017_20_KG3_FOTR_Registers *struct_Registers;
  
};
 
//------------------------------------------------------------------------------
 
class TP017_20_KG3_FOTR_T2 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public type definitions
    //--------------------------------------------------------------------------
 
    //!  @brief Register structure for generic access
    typedef struct
    {
 
      //! @brief 0x00 : Unit identification L read register
      U16 u16_Unit_ID_L;        
      
      //! @brief 0x01 : Unit identification H read register
      U16 u16_Unit_ID_H;        
      
      //! @brief 0x02 : Not used
      U16 u16_Reserved_2;
      
      //! @brief 0x03 : RX data read register
      // Bit 0    : RX Channel 1
      // Bit 1    : RX Channel 2
      // Bit 2    : RX Channel 3
      // Bit 3    : RX Channel 4
      // Bit 4    : RX Channel 5
      // Bit 5    : RX Channel 6
      // Bit 6-15  : Reserved
      U16 u16_RX_Data;          
      
      //! @brief 0x04 : Not used
      U16 u16_Reserved_4;       
      
      //! @brief 0x05 : Not used
      U16 u16_Reserved_5;       
      
      //! @brief 0x06 : Not used
      U16 u16_Reserved_6;       
      
      //! @brief 0x07 : TX output data write register
      // Bit 0    : TX Channel 1
      // Bit 1    : TX Channel 2
      // Bit 2    : TX Channel 3
      // Bit 3    : TX Channel 4
      // Bit 4    : TX Channel 5
      // Bit 5    : TX Channel 6
      // Bit 6-15  : Reserved     
      U16 u16_TX_Data;          
 
      //! @brief 0x08 : Reserved
      U16 u16_Reserved_8; 
 
      //! @brief 0x09 : Reserved
      U16 u16_Reserved_9;       
      
      //! @brief 0x0A : Reserved
      U16 u16_Reserved_10;
 
      //! @brief 0x0B : Not used
      U16 u16_Reserved_11;      
      
      //! @brief 0x0C : Not used
      U16 u16_Reserved_12;      
      
      //! @brief 0x0D : Not used
      U16 u16_Reserved_13;      
      
      //! @brief 0x0E : Not used
      U16 u16_Reserved_14;      
      
      //! @brief 0x0F : Not used
      U16 u16_Reserved_15;      
 
    } TP017_20_KG3_FOTR_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    TP017_20_KG3_FOTR_T2();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP017_20_KG3_FOTR_T2();
 
    //!-------------------------------------------------------------------------
    //! @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( TP017_20_KG3_FOTR_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 about digital I/O baortd driver over communication link protocol
    //! @note      This method sends information about digital I/O driver over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
    
    //! @brief TX channel data
    TBlock_Input_Connector object_u16_TX_Channels_Control;
 
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
 
    //! @brief RX channel status
    TBlock_Output_Connector object_u16_RX_Channels_Status;
 
    
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief Hardware mapped registers
    volatile TP017_20_KG3_FOTR_Registers *struct_Registers;
  
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------