P017_52_KG3_CI.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P017_52_KG3_CI.h
//! @brief      KG3 current input board P017.52 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_52_KG3_CI/P017_52_KG3_CI.h $
//!             $Revision: 2457 $
//!             $Date: 2021-03-11 11:54:01 +0500 (Do, 11 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 Analog current input KG3 CI T1 (P017.52) board class
class TP017_52_KG3_CI_T1 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //! @brief Register structure for generic access
    typedef struct
    {
 
      //------------------------------------------------------------------------
      // Unit identification registers
      //------------------------------------------------------------------------
 
      //! @brief 0x00 : Module identification register, low word
      U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Module identification register, high word
      U16 u16_Unit_ID_H;
 
      //------------------------------------------------------------------------
      // Control and status registers
      //------------------------------------------------------------------------
 
      //! @brief control and status register
      union
      {
 
        //! @brief 0x02 : Status register
        U16 u16_Analog_Input_Status;
 
        //! @brief 0x02 : Control register
        U16 u16_Analog_Input_Control;
 
      };
 
      //------------------------------------------------------------------------
      // Analog value registers
      //------------------------------------------------------------------------
 
      //! @brief 0x03 : Analog input channel 1 data register as U16 value
      U16 u16_Analog_Input_Data_1;
 
      //! @brief 0x04 : Analog input channel 2 data register as U16 value
      U16 u16_Analog_Input_Data_2;
 
      //! @brief 0x05 : Analog input channel 3 data register as U16 value
      U16 u16_Analog_Input_Data_3;
 
      //! @brief 0x06 : Analog input channel 4 data register as U16 value
      U16 u16_Analog_Input_Data_4;
 
      //! @brief 0x07 : Analog input channel 1 filtered data register as U16 value
      U16 u16_Analog_Input_Filtered_Data_1;
 
      //! @brief 0x08 : Analog input channel 2 filtered data register as U16 value
      U16 u16_Analog_Input_Filtered_Data_2;
 
      //! @brief 0x09 : Analog input channel 3 filtered data register as U16 value
      U16 u16_Analog_Input_Filtered_Data_3;
 
      //! @brief 0x0A : Analog input channel 4 filtered data register as U16 value
      U16 u16_Analog_Input_Filtered_Data_4;
 
    } TP017_52_KG3_CI_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP017_52_KG3_CI_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP017_52_KG3_CI_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Map function block to the hardware.
    //! @note      None.
    //! @param     [in] *struct_Registers_Base_Address - Pointer to the hardware allocated memory
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TP017_52_KG3_CI_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Block initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init(); //!< Block initialisation method
 
    //!-------------------------------------------------------------------------
    //! @brief     Block execution method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about function block over communication link protocol.
    //! @note      This method sends information about function block 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 ); //!< Send information method
 
    //--------------------------------------------------------------------------
    // Functional block parameters
    //--------------------------------------------------------------------------
 
    //! @brief Analog input channel 1 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_1;
 
    //! @brief Analog input channel 2 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_2;
 
    //! @brief Analog input channel 3 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_3;
 
    //! @brief Analog input channel 4 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_4;
 
    //! @brief Analog input channel 1 offset input connector
    TBlock_Input_Connector object_f32_Analog_Input_Offset_1;
 
    //! @brief Analog input channel 2 offset input connector
    TBlock_Input_Connector object_f32_Analog_Input_Offset_2;
 
    //! @brief Analog input channel 3 offset input connector
    TBlock_Input_Connector object_f32_Analog_Input_Offset_3;
 
    //! @brief Analog input channel 4 offset input connector
    TBlock_Input_Connector object_f32_Analog_Input_Offset_4;
 
    //! @brief Analog input channel 1 gain input connector
    TBlock_Input_Connector object_f32_Analog_Input_Gain_1;
 
    //! @brief Analog input channel 2 gain input connector
    TBlock_Input_Connector object_f32_Analog_Input_Gain_2;
 
    //! @brief Analog input channel 3 gain input connector
    TBlock_Input_Connector object_f32_Analog_Input_Gain_3;
 
    //! @brief Analog input channel 4 gain input connector
    TBlock_Input_Connector object_f32_Analog_Input_Gain_4;
 
    //! @brief Negate input data input connector
    TBlock_Input_Connector object_bool_Negate;
 
    //--------------------------------------------------------------------------
    // Functional block inputs
    //--------------------------------------------------------------------------
 
//    TBlock_Input_Connector object_f32_Software_Overcurrent_Level; //! @brief Software defined overcurrent level
 
    //--------------------------------------------------------------------------
    // Functional block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Analog input status output connector
    TBlock_Output_Connector object_u16_Analog_Input_Status;
 
    //! @brief Analog input channel 1 block output as U16
    TBlock_Output_Connector object_u16_Analog_Input_Raw_Data_1;
 
    //! @brief Analog input channel 2 block output as U16
    TBlock_Output_Connector object_u16_Analog_Input_Raw_Data_2;
 
    //! @brief Analog input channel 3 block output as U16
    TBlock_Output_Connector object_u16_Analog_Input_Raw_Data_3;
 
    //! @brief Analog input channel 4 block output as U16
    TBlock_Output_Connector object_u16_Analog_Input_Raw_Data_4;
 
    //! @brief Analog input channel 1 block output connecor
    TBlock_Output_Connector object_f32_Analog_Input_Data_1;
 
    //! @brief Analog input channel 2 block output connector
    TBlock_Output_Connector object_f32_Analog_Input_Data_2;
 
    //! @brief Analog input channel 3 block output connecor
    TBlock_Output_Connector object_f32_Analog_Input_Data_3;
 
    //! @brief Analog input channel 4 block output connector
    TBlock_Output_Connector object_f32_Analog_Input_Data_4;
 
    //! @brief Critical hardware error flag connecto
    TBlock_Output_Connector object_bool_Hardware_Error;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief Status register structure
    typedef union
    {
 
      // Status register U16 based representartion
      U16 u16_Status;
 
      //! @brief Status register bits based representation
      struct
      {
 
        //! @brief Bit 0 : Hardware fault of ADC channel 1
        U16 u16_ADC_Hardware_Fault_1:1;
 
        //! @brief Bit 2 : Hardware fault of ADC channel 2
        U16 u16_ADC_Hardware_Fault_2:1;
 
        //! @brief Bit 2 : Hardware fault of ADC channel 3
        U16 u16_ADC_Hardware_Fault_3:1;
 
        //! @brief Bit 3 : Hardware fault of ADC channel 4
        U16 u16_ADC_Hardware_Fault_4:1;
 
        //! @brief Bit 4 : Not used
        U16 :1;
 
        //! @brief Bit 5 : Not used
        U16 :1;
 
        //! @brief Bit 6 : Not used
        U16 :1;
 
        //! @brief Bit 7 : Not used
        U16 :1;
 
        //! @brief Bit 8 : Not used
        U16 :1;
 
        //! @brief Bit 9 : Not used
        U16 :1;
 
        //! @brief Bit 10 : Not used
        U16 :1;
 
        //! @brief Bit 11 : Not used
        U16 :1;
 
        //! @brief Bit 12 : Not used
        U16 :1;
 
        //! @brief Bit 13 : Not used
        U16 :1;
 
        //! @brief Bit 14 : Not used
        U16 :1;
 
        //! @brief Bit 15 : Not used
        U16 :1;
 
      };
 
    } TStatus;
 
    //! @brief Hardware mapped registers
    volatile TP017_52_KG3_CI_Registers *struct_Registers;
 
    //! @brief Effective gain of the channel 1
    F32 f32_Gain_1;
 
    //! @brief Effective gain of the channel 2
    F32 f32_Gain_2;
 
    //! @brief Effective gain of the channel 3
    F32 f32_Gain_3;
 
    //! @brief Effective gain of the channel 4
    F32 f32_Gain_4;
 
    //! @brief Effective offset of the channel 1
    F32 f32_Offset_1;
 
    //! @brief Effective offset of the channel 2
    F32 f32_Offset_2;
 
    //! @brief Effective offset of the channel 3
    F32 f32_Offset_3;
 
    //! @brief Effective offset of the channel 4
    F32 f32_Offset_4;
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------