P019_11_KG3_FC.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P019_11_KG3_FC.h
//! @brief      KG3 flow converter board P019.11 V1 T1 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/P019_11_KG3_FC/P019_11_KG3_FC.h $
//!             $Revision: 2836 $
//!             $Date: 2021-08-02 21:10:02 +0500 (Mo, 02 Aug 2021) $
//!             $Author: ggavrituhin $
//------------------------------------------------------------------------------
//
// 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 "NTCT_Sensor.h"
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class declaration
//------------------------------------------------------------------------------
 
//! @brief Function block class declaration
class TP019_11_KG3_FC : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
 
    //! @brief Register structure for I/O access
    typedef struct
    {
 
      //! @brief 0x00 : Module identification low register
      volatile U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Module identification high register
      volatile U16 u16_Unit_ID_H;
 
      //! @brief Control and status registars
      union
      {
 
        //! @brief 0x02 : Flow converter status register
        volatile U16 u16_Status_Register;
 
        //! @brief 0x02 : Flow converter control register
        // Bit 0    : Flow converter enable
        // Bit 1    : Synchron rectifier enable
        // Bit 15-2 : Not used
        volatile U16 u16_Control_Register;
 
      };
 
      //! @brief 0x03 : Flow converter active time register 
      //! @note Resolution: 20ns at 50 MHz FPGA clock
      volatile U16 u16_Inverter_Period_Time;
 
      //! @brief 0x04 : Flow converter dead time register
      //! @note Resolution: 20ns at 50 MHz FPGA clock
      volatile U16 u16_Inverter_Active_time;
        
      //! @brief 0x05 : Rectifier offset time register
      //! @note Resolution: 20ns at 50 MHz FPGA clock
      volatile U16 u16_Rectifier_Offset_Time;
 
      //! @brief 0x06 : Rectifier active time register
      //! @note Resolution: 20ns at 50 MHz FPGA clock
      volatile U16 u16_Rectifier_Trail_Time;
 
      //! @brief 0x07 : Reserved
      volatile U16 u16_Reserve_07;
 
      //! @brief 0x08 : Flow convertor input current
      volatile I16 i16_Input_Current;
 
      //! @brief 0x09 : Flow convertor input voltage
      volatile I16 i16_Input_Voltage;
 
      //! @brief 0x0A : Modulator output current
      volatile I16 i16_Output_Current;
 
      //! @brief 0x0B : Modulator output voltage
      volatile I16 i16_Output_Voltage;
 
 
      //! @brief 0x0C : Flow convertor input current offset
      volatile I16 i16_Input_Current_Offset;
 
      //! @brief 0x0D : Flow convertor input voltage offset
      volatile I16 i16_Input_Voltage_Offset;
 
      //! @brief 0x0E : Modulator output current offset
      volatile I16 i16_Output_Current_Offset;
 
      //! @brief 0x0F : Modulator output voltage offset
      volatile I16 i16_Output_Voltage_Offset;
 
 
      //! @brief 0x10 : Temperature data of the flow convertion
      volatile U16 u16_Temperature;
 
      //! @brief 0x11 : Rectifier output current positive reference signal
      volatile U16 u16_Rectifier_Output_Current_Positive_Reference;
 
      //! @brief 0x12 : Rectifier output current negative reference signal
      volatile U16 u16_Rectifier_Output_Current_Negative_Reference;
 
      //! @brief 0x13 : Reserved
      volatile U16 u16_Reserve_19;
 
      //! @brief 0x14 : Reserved
      volatile U16 u16_Reserve_20;
 
      //! @brief 0x15 : Reserved
      volatile U16 u16_Reserve_21;
 
      //! @brief 0x16 : Reserved
      volatile U16 u16_Reserve_22;
 
      //! @brief 0x17 : Reserved
      volatile U16 u16_Reserve_23;
 
      //! @brief 0x18 : Reserved
      volatile U16 u16_Reserve_24;
 
      //! @brief 0x19 : Reserved
      volatile U16 u16_Reserve_25;
 
      //! @brief 0x1A : Reserved
      volatile U16 u16_Reserve_26;
 
      //! @brief 0x1B : Reserved
      volatile U16 u16_Reserve_27;
 
      //! @brief 0x1C : Reserved
      volatile U16 u16_Reserve_28;
 
      //! @brief 0x1D : Reserved
      volatile U16 u16_Reserve_29;
 
      //! @brief 0x1E : Reserved
      volatile U16 u16_Reserve_30;
 
      //! @brief 0x1F : Reserved
      volatile U16 u16_Reserve_31;
 
    } TP019_11_KG3_FC_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP019_11_KG3_FC();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP019_11_KG3_FC();
 
    //!-------------------------------------------------------------------------
    //! @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( TP019_11_KG3_FC_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 flow converter board driver over communication link protocol
    //! @note      This method sends information about flow converter driver over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    //! @brief Enable flow converter
    TBlock_Input_Connector object_bool_Enable;
 
    //! @brief Output current positive magnitude setpoint
    TBlock_Input_Connector object_f32_Positive_Magnitude;
 
    //! @brief Output current negative magnitude setpoint
    TBlock_Input_Connector object_f32_Negative_Magnitude;
 
    //! @brief Flow converter dead time input
    TBlock_Input_Connector object_u16_Dead_Time;
 
    //! @brief Input current gain calibration
    TBlock_Input_Connector object_f32_Input_Current_Gain;
 
    //! @brief Input current offset calibration
    TBlock_Input_Connector object_f32_Input_Current_Offset;
 
    //! @brief Output current gain calibration
    TBlock_Input_Connector object_f32_Output_Current_Gain;
 
    //! @brief Output current offset calibration
    TBlock_Input_Connector object_f32_Output_Current_Offset;
 
    //! @brief Input voltage gain calibration
    TBlock_Input_Connector object_f32_Input_Voltage_Gain;
 
    //! @brief Input voltage offset calibration
    TBlock_Input_Connector object_f32_Input_Voltage_Offset;
 
    //! @brief Output voltage gain calibration
    TBlock_Input_Connector object_f32_Output_Voltage_Gain;
 
    //! @brief Output voltage offset calibration
    TBlock_Input_Connector object_f32_Output_Voltage_Offset;
 
    //! @brief Temperature gain calibration
    TBlock_Input_Connector object_f32_Temperature_Gain;
 
    //! @brief Temperature offset calibration
    TBlock_Input_Connector object_f32_Temperature_Offset;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Actual input current in amper
    TBlock_Output_Connector object_f32_Input_Current;
 
    //! @brief Actual input voltage in volt
    TBlock_Output_Connector object_f32_Input_Voltage;
 
    //! @brief Actual output current in amper
    TBlock_Output_Connector object_f32_Output_Current;
 
    //! @brief Actual output voltage in volt
    TBlock_Output_Connector object_f32_Output_Voltage;
 
    //! @brief Actual output impedance 
    TBlock_Output_Connector object_f32_Output_Impedance;
 
    //! @brief Actual flow converter temperature in gradus celsius
    TBlock_Output_Connector object_f32_Temperature;
 
    //! @brief Actual input current raw data
    TBlock_Output_Connector object_i16_Input_Current_Raw_Data;
 
    //! @brief Actual input voltage raw data
    TBlock_Output_Connector object_i16_Input_Voltage_Raw_Data;
 
    //! @brief Actual output current raw data
    TBlock_Output_Connector object_i16_Output_Current_Raw_Data;
 
    //! @brief Actual output voltage raw data
    TBlock_Output_Connector object_i16_Output_Voltage_Raw_Data;
 
    //! @brief Actual flow converter temperature raw data
    TBlock_Output_Connector object_u16_Temperature_Raw_Data;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
 
    //! @brief Control register structure
    typedef union
    {
 
      //! @brief Control register raw U16 data
      U16 u16_Raw_Data;
 
      //! @brief Control register bit parsing structure
      struct
      {
 
        //! @brief Bit 0 : Enable inverter outputs ( 0 - Disabled, 1 - Enabled )
        U16 bit1_Inverter_Output_Enable :1;
 
        //! @brief Bit 1 : Enable rectifier outputs ( 0 - Disabled, 1 - Enabled )
        U16 bit1_Rectifier_Output_Enable :1;
 
        //! @brief Bits 2..15 : Reserved
        U16 bit14_Reserved_Bit_2_15 :14;
 
      };
 
    } TControl_Register;
 
    //! @brief Status register bit mapping structure
    typedef struct
    {
 
      //! @brief Status register, bit 0
      U16 bit1_Reserved_Bit_0 :1;
 
      //! @brief Status register, bit 1
      U16 bit1_Reserved_Bit_1 :1;
 
      //! @brief Status register, bit 2
      U16 bit1_Reserved_Bit_2 :1;
 
      //! @brief Status register, bit 3
      U16 bit1_Reserved_Bit_3 :1;
 
      //! @brief Status register, bit 4
      U16 bit1_Reserved_Bit_4 :1;
 
      //! @brief Status register, bit 5
      U16 bit1_Reserved_Bit_5 :1;
 
      //! @brief Status register, bit 6
      U16 bit1_Reserved_Bit_6 :1;
 
      //! @brief Status register, bit 7
      U16 bit1_Reserved_Bit_7 :1;
 
      //! @brief Status register, bit 8
      U16 bit1_Reserved_Bit_8 :1;
 
      //! @brief Status register, bit 9
      U16 bit1_Reserved_Bit_9 :1;
 
      //! @brief Status register, bit 10
      U16 bit1_Reserved_Bit_10 :1;
 
      //! @brief Status register, bit 11
      U16 bit1_Reserved_Bit_11 :1;
 
      //! @brief Status register, bit 12
      U16 bit1_Reserved_Bit_12 :1;
 
      //! @brief Status register, bit 13
      U16 bit1_Reserved_Bit_13 :1;
 
      //! @brief Status register, bit 14
      U16 bit1_Reserved_Bit_14 :1;
 
      //! @brief Status register, bit 15
      U16 bit1_Reserved_Bit_15 :1;
 
    } TStatus_Register;
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief FPGA mapped registers
    volatile TP019_11_KG3_FC_Registers *struct_Registers = (TP019_11_KG3_FC_Registers *)NULL;
 
    //! @brief NTC sensor object
    TNTC object_NTC;
 
    F32 f32_Output_Current_Positive_Reference = (F32)0.0f;
    F32 f32_Output_Current_Negative_Reference = (F32)0.0f;
 
    U16 u16_Output_Current_Positive_Reference = (U16)0x0000;
    U16 u16_Output_Current_Negative_Reference = (U16)0x0000;
 
    //
    I16 i16_Output_Current_Offset_Raw = (I16)0;
    
    I16 i16_Input_Current = (I16)0;
    I16 i16_Input_Voltage = (I16)0;
    I16 i16_Output_Current = (I16)0;
    I16 i16_Output_Voltage = (I16)0;
 
    F32 f32_Input_Current = (F32)0.0f;
    F32 f32_Input_Voltage = (F32)0.0f;
    F32 f32_Output_Current = (F32)0.0f;
    F32 f32_Output_Voltage = (F32)0.0f;
 
    //! @brief Temperature value
    F32 f32_Temperature = (F32)0.0f;
 
    F32 f32_Output_Current_1 = (F32)0.0f;
    F32 f32_Output_Voltage_1 = (F32)0.0f;
    
    BOOL bool_First_Loop = (BOOL)true;
 
//    F32 f32_Duty = (F32)0.0f;
 
    F32 f32_Delta_Voltage = (F32)0.0f;
 
    U16 u16_Inverter_Active_Time = (U16)0x0000;
    F32 f32_Inverter_Minimal_Active_Time = (F32)0.0f;
    F32 f32_Inverter_Maximal_Active_Time = (F32)0.0f;
    F32 f32_Inverter_Active_Time = (F32)0.0f;
    
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------