KG3_PLC.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file        KG3_PLC.h
//! @author      ANVILEX GmbH
//! @version     V1.0
//! @date        02.11.2018
//! @brief       Function block template class header file.
//! @attention
//!
//! COPYRIGHT(C) 2018 ANVILEX GmbH
//!
//! 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class declarations
//------------------------------------------------------------------------------
 
//! @brief Power line communication class, type 0 declaration
class TKG3_PLC_T0 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, variables and methods
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
    
    //! @brief Register structure for generic access
    typedef struct
    {
 
      //! @brief 0x00 : Module identification register
      U16 u16_Unit_ID_L;
      
      //! @brief 0x01 : Module identification register
      U16 u16_Unit_ID_H;
      
      //! @brief 0x02 : Module carrier halfperiod register
      U16 u16_Carrier_Halfperiod;
      
      //! @brief 0x03 : Module modulation halfperiod register
      U16 u16_Modulation_Halfperiod;
 
    } TKG3_PLC_Registers;
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TKG3_PLC_T0();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TKG3_PLC_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( TKG3_PLC_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 driver over communication link protocol
    //! @note      This method sends information about 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 );
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    //! @brief Carrier halfperiod
    TBlock_Input_Connector object_u16_Set_Point_Carrier_Halfperiod;
    
    //! @brief Modulation halfperiod
    TBlock_Input_Connector object_u16_Set_Point_Modulation_Halfperiod;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
  //----------------------------------------------------------------------------
  // Protected defines, variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, variables and methods
  //----------------------------------------------------------------------------
 
  private:
    
    //! @brief Pointer to the memory area in FPGA address space
    volatile TKG3_PLC_Registers *struct_Registers = (TKG3_PLC_Registers*)NULL;
 
};
 
//------------------------------------------------------------------------------
 
//! @brief Power line communication class, type 1 declaration
class TKG3_PLC_T1 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, variables and methods
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
    
    //! @brief Register structure for generic access
    typedef struct
    {
 
      //! @brief 0x00 : Module identification register
      U16 u16_Unit_ID_L;
      
      //! @brief 0x01 : Module identification register
      U16 u16_Unit_ID_H;
 
    } TKG3_PLC_Registers;
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TKG3_PLC_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TKG3_PLC_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( TKG3_PLC_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 driver over communication link protocol
    //! @note      This method sends information about 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 );
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
  //----------------------------------------------------------------------------
  // Protected defines, variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, variables and methods
  //----------------------------------------------------------------------------
 
  private:
    
    //! @brief Pointer to the memory area in FPGA address space
    volatile TKG3_PLC_Registers *struct_Registers = (TKG3_PLC_Registers*)NULL;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------