KG3_CAB_EXT_T1.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file        KG3_CAB_EXT_T1.h
//! @author      ANVILEX LLC
//! @version     V1.0
//! @date        02.11.2018
//! @brief       Function block template class header file.
//! @attention
//!
//! COPYRIGHT(C) 2018-2021 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.
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// 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 "PRT_Sensor.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class declarations
//------------------------------------------------------------------------------
 
//! @brief Cabunet board class, type 1 declaration
class TKG3_CAB_EXT_T1 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, variables and methods
  //----------------------------------------------------------------------------
 
  public:
 
    //! @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 : Control register
      U16 u16_Control_Register;
    
      //! @brief 0x03 : Status register
      U16 u16_Status_Register;
 
      //! @brief 0x04 : Cabinet temperature register
      U16 u16_Cabinet_Temperature_Register;
 
    } TKG3_CAB_EXT_T1_Registers;
 
    //--------------------------------------------------------------------------
    // Constructor and destructor methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TKG3_CAB_EXT_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TKG3_CAB_EXT_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_CAB_EXT_T1_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 Cabinet temperature offset output connector
    TBlock_Input_Connector object_f32_Temperature_Gain;
 
    //! @brief Cabinet temperature offset input connector
    TBlock_Input_Connector object_f32_Temperature_Offset;
 
    //! @brief Fan control input connector
    TBlock_Input_Connector object_bool_Fan_Control;
 
    //! @brief Heater control input connector
    TBlock_Input_Connector object_bool_Heater_Control;
 
    //! @brief Temperature gain value
    TBlock_Input_Connector object_f32_Gain;
    
    //! @brief Temperature offset value
    TBlock_Input_Connector object_f32_Offset;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Door status output connector
    TBlock_Output_Connector object_bool_Door_Status;
 
    //! @brief Door emergency stop button status output connector
    TBlock_Output_Connector object_bool_Door_Emergency_Stop_Button_Status;
 
    //! @brief Fan state
    TBlock_Output_Connector object_bool_Fan_Contactor_Status;
 
    //! @brief Heater state
    TBlock_Output_Connector object_bool_Heater_Contactor_Status;
 
    //! @brief Raw data temperature value
    TBlock_Output_Connector object_u16_Temperature_Raw_Data;
 
    //! @brief Temperature value after processing
    TBlock_Output_Connector object_f32_Temperature;
 
  //----------------------------------------------------------------------------
  // Protected defines, variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, variables and methods
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief Structure control register for bit parsing
    typedef union
    {
 
      //! @brief Raw data
      U16 u16_Raw_Data;
 
      //! @brief Structure of the bits
      struct
      {
 
        //! @brief Bit 0, Cabinet heater control
        U16 bool_Cabinet_Heater_Control:1;
 
        //! @brief Bit 1, Cabinet fan control
        U16 bool_Cabinet_Fan_Control:1;
 
        //! @brief Bits 2..15, unused bits
        U16 :14;
 
      };
 
    }TControl_Register;
    
    //! @brief Structure status register for bit parsing
    typedef union
    {
 
      //! @brief Raw data
      U16 u16_Raw_Data;
 
      //! @brief Structure of the bits
      struct
      {
 
        //! @brief Bit 0, Cabinet door status
        U16 bool_Cabinet_Door_Status:1;
 
        //! @brief Bit 1, Cabinet emergency stop button status
        U16 bool_Cabinet_Emergency_Stop_Status:1;
 
        //! @brief Bits 2..15, unused bits
        U16 :14;
 
      };
 
    }TStatus_Register;
    
    //! @brief object PRT
    TPRT object_PRT;
    
    //! @brief Sensor valid data count
    U32 u32_Sensor_Valid_Data_Count;
 
    //! @brief Open sensor error count
    U32 u32_Sensor_Open_Error_Count;
    
    //! @brief Short sensor error coun
    U32 u32_Sensor_Short_Error_Count;
    
    //! @brief Pointer to the memory area in FPGA address space
    volatile TKG3_CAB_EXT_T1_Registers *struct_Registers;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------