Function_Block_FPGA_Trip_Controller.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_FPGA_Trip_Controller.h
//! @brief     Function block FPGA trip request manager class header file.
//! @copyright ANVILEX LLC
//! @attention No special attention requered.
//!            $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Blocks/Hardware/Function_Block_FPGA_Trip_Controller.h $
//!            $Revision: 2904 $
//!            $Date: 2021-12-02 02:39:23 +0500 (Do, 02 Dez 2021) $
//!            $Author: minch $
//
// Copyright(C) 2008-2020 ANVILEX LLC
//
// 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.
//
//------------------------------------------------------------------------------
//
// TFunction_Block_FPGA_Trip_Controller_T0
// TFunction_Block_FPGA_Trip_Controller_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"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//! @brief Function block FPGA trip request manager type 0 class
class TFunction_Block_FPGA_Trip_Controller_T0 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //! @brief Register structure for generic access
    typedef struct
    {
 
      //! @brief 0x00 : Unit identification L registers
      U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Unit identification H registers
      U16 u16_Unit_ID_H;
 
      //! @brief 0x02 : Control register
      U16 u16_Control;
 
      //! @brief 0x03 : Status register
      U16 u16_Status;
 
      //! @brief 0x04 : Trip request latch register 1
      U16 u16_Trip_Request_Latch_1;
 
      //! @brief 0x05 : Trip request latch register 2
      U16 u16_Trip_Request_Latch_2;
 
      //! @brief 0x06 : Trip request latch register 3
      U16 u16_Trip_Request_Latch_3;
 
      //! @brief 0x07 : Trip request latch register 4
      U16 u16_Trip_Request_Latch_4;
 
      //! @brief 0x08 : Trip request register 1
      U16 u16_Trip_Request_1;
 
      //! @brief 0x09 : Trip request register 2
      U16 u16_Trip_Request_2;
 
      //! @brief 0x0A : Trip request register 3
      U16 u16_Trip_Request_3;
 
      //! @brief 0x0B : Trip request register 4
      U16 u16_Trip_Request_4;
 
      //! @brief 0x0C : Not used
      U16 u16_Reserve_C;
 
      //! @brief 0x0D : Not used
      U16 u16_Reserve_D;
 
      //! @brief 0x0E : Not used
      U16 u16_Reserve_E;
 
      //! @brief 0x0F : Not used
      U16 u16_Reserve_F;
 
    } TFPGA_Trip_Controller_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_FPGA_Trip_Controller_T0();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_FPGA_Trip_Controller_T0();
 
    //!-------------------------------------------------------------------------
    //! @brief     Hardware mapping method
    //! @note      This method map function block to the hardware.
    //! @param     [in] *struct_Registers_Base_Address - Pointer to the base address of the hardware registers
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TFPGA_Trip_Controller_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send detailed information about finction block
    //! @note      This method sends detailed information function block.
    //! @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
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block input
    //--------------------------------------------------------------------------
 
    //! @brief Reset signal input
    TBlock_Input_Connector object_bool_Reset;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Error output
    TBlock_Output_Connector object_bool_Trip_Request_Output;
 
    //! @brief Trip request latch status output 1
    TBlock_Output_Connector object_u32_Trip_Request_Latch_1;
 
    //! @brief Trip request latch status output 2
    TBlock_Output_Connector object_u32_Trip_Request_Latch_2;
 
    //! @brief Trip request status output 1
    TBlock_Output_Connector object_u32_Trip_Request_1;
 
    //! @brief Trip request status output 2
    TBlock_Output_Connector object_u32_Trip_Request_2;
 
  //----------------------------------------------------------------------------
  // Protected variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, variables and methods
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief FPGA mapped registers
    TFPGA_Trip_Controller_Registers *struct_Registers;
 
    //! @brief Trip request latch value 1
    U16 u16_Trip_Request_Latch_1;
 
    //! @brief Trip request latch value 2
    U16 u16_Trip_Request_Latch_2;
 
    //! @brief Trip request latch value 3
    U16 u16_Trip_Request_Latch_3;
 
    //! @brief Trip request latch value 4
    U16 u16_Trip_Request_Latch_4;
 
    //! @brief Trip request value 1
    U16 u16_Trip_Request_1;
 
    //! @brief Trip request value 2
    U16 u16_Trip_Request_2;
 
    //! @brief Trip request value 3
    U16 u16_Trip_Request_3;
 
    //! @brief Trip request value 4
    U16 u16_Trip_Request_4;
 
};
 
//------------------------------------------------------------------------------
 
//! @brief Function block FPGA trip request manager type 1 class
class TFunction_Block_FPGA_Trip_Controller_T1 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    // Register structure for generic access
    typedef struct
    {
 
      //! @brief 0x00 : Unit identification L registers
      U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Unit identification H registers
      U16 u16_Unit_ID_H;
 
      //! @brief 0x02 : Control register
      U16 u16_Control;
 
      //! @brief 0x03 : Status register
      U16 u16_Status;
 
      //! @brief 0x04 : Trip request latch register 1
      U16 u16_Trip_Request_Latch_1;
 
      //! @brief 0x05 : Trip request latch register 2
      U16 u16_Trip_Request_Latch_2;
 
      //! @brief 0x06 : Trip request latch register 3
      U16 u16_Trip_Request_Latch_3;
 
      //! @brief 0x07 : Trip request latch register 4
      U16 u16_Trip_Request_Latch_4;
 
      //! @brief 0x08 : Trip request register 1
      U16 u16_Trip_Request_1;
 
      //! @brief 0x09 : Trip request register 2
      U16 u16_Trip_Request_2;
 
      //! @brief 0x0A : Trip request register 3
      U16 u16_Trip_Request_3;
 
      //! @brief 0x0B : Trip request register 4
      U16 u16_Trip_Request_4;
 
      //! @brief 0x0C : Not used
      U16 u16_Reserve_C;
 
      //! @brief 0x0D : Not used
      U16 u16_Reserve_D;
 
      //! @brief 0x0E : Not used
      U16 u16_Reserve_E;
 
      //! @brief 0x0F : Not used
      U16 u16_Reserve_F;
 
    } TFPGA_Trip_Controller_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_FPGA_Trip_Controller_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_FPGA_Trip_Controller_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Hardware mapping method
    //! @note      This method map function block to the hardware.
    //! @param     [in] *struct_Registers_Base_Address - Pointer to the base address of the hardware registers
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TFPGA_Trip_Controller_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send detailed information about finction block
    //! @note      This method sends detailed information function block.
    //! @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
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    //! @brief Reset signal input
    TBlock_Input_Connector object_bool_Reset;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Trip request output
    TBlock_Output_Connector object_bool_Trip_Request_Output;
 
    //! @brief Trip request latch status output 1
    TBlock_Output_Connector object_u32_Trip_Request_Latch_1;
 
    //! @brief Trip request latch status output 2
    TBlock_Output_Connector object_u32_Trip_Request_Latch_2;
 
    //! @brief Trip request status output 1
    TBlock_Output_Connector object_u32_Trip_Request_1;
 
    //! @brief Trip request status output 2
    TBlock_Output_Connector object_u32_Trip_Request_2;
 
  //----------------------------------------------------------------------------
  // Protected defines, variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, variables and methods
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief FPGA mapped registers
    TFPGA_Trip_Controller_Registers *struct_Registers;
 
    //! @brief Trip request latch value 1
    U16 u16_Trip_Request_Latch_1;
 
    //! @brief Trip request latch value 2
    U16 u16_Trip_Request_Latch_2;
 
    //! @brief Trip request latch value 3
    U16 u16_Trip_Request_Latch_3;
 
    //! @brief Trip request latch value 4
    U16 u16_Trip_Request_Latch_4;
 
    //! @brief Trip request value 1
    U16 u16_Trip_Request_1;
 
    //! @brief Trip request value 2
    U16 u16_Trip_Request_2;
 
    //! @brief Trip request value 3
    U16 u16_Trip_Request_3;
 
    //! @brief Trip request value 4
    U16 u16_Trip_Request_4;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------