P019_11_KG3_MOD.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P019_11_KG3_MOD.h
//! @brief      KG3 modulator board P019.11 MOD 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_MOD/P019_11_KG3_MOD.h $
//!             $Revision: 2877 $
//!             $Date: 2021-10-18 23:04:26 +0500 (Mo, 18 Okt 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 "NTCT_Sensor.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Extention board driver block P019.11 (KG3 MOD) class definition
class TP019_11_KG3_MOD : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, variables and methods
  //----------------------------------------------------------------------------
 
  public:
 
    //! @brief Register structure for I/O access
    typedef struct
    {
 
      //! @brief 0x00 : Module identification low register
      U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Module identification high register
      U16 u16_Unit_ID_H;
 
      //! @brief Control and status registars
      union
      {
 
        //! @brief 0x02 : Modulator status register
        U16 u16_Status_Register;
 
        //! @brief 0x02 : Modulator control register
        // Bit 0    : Modulator enable
        // Bit 1    : Modulator PWM T1 output enable
        // Bit 2    : Modulator PWM T2 output enable
        // Bit 3    : Modulator PWM T3 output enable
        // Bit 4    : Modulator PWM T5 output enable
        // Bit 5    : Modulator driver enable
        // Bit 15-6 : Not used
        U16 u16_Control_Register;
 
      };
 
      //! @brief 0x03 : Reserved
      U16 u16_Reserve_3;
 
      //! @brief 0x04 : Modulator "on" time in clock cycles (low register)
      U16 u16_On_Cycles_L;
 
      //! @brief 0x05 : Modulator "on" time in clock cycles (high register)
      U16 u16_On_Cycles_H;
 
      //! @brief 0x06 : Modulator "off" time in clock cycles (low register)
      U16 u16_Off_Cycles_L;
 
      //! @brief 0x07 : Modulator "off" time in clock cycles (high register)
      U16 u16_Off_Cycles_H;
 
      //! @brief 0x08 : Modulator dead time
      U16 u16_Dead_Time;
 
      //! @brief 0x09 : Reserved
      U16 u16_Reserve_9;
 
      //! @brief 0x0A : Temperature time register
      U16 u16_Temperature;
 
      //! @brief 0x0B : Reserved
      U16 u16_Reserve_11;
 
      //! @brief 0x0C : Reserved
      U16 u16_Reserve_12;
 
      //! @brief 0x0D : Reserved
      U16 u16_Reserve_13;
 
      //! @brief 0x0E : Reserved
      U16 u16_Reserve_14;
 
      //! @brief 0x0F : Reserved
      U16 u16_Reserve_15;
 
    } TP019_11_KG3_MOD_Registers;
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP019_11_KG3_MOD();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP019_11_KG3_MOD();
 
    //!-------------------------------------------------------------------------
    //! @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_MOD_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 modulator board driver over communication link protocol
    //! @note      This method sends information about modulator board 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 );
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    //! @brief Enable modulator
    TBlock_Input_Connector object_bool_Enable;
 
    //! @brief Modulator dead time
    TBlock_Input_Connector object_u16_Dead_Time;
 
    //! @brief Frequency setpoint
    TBlock_Input_Connector object_f32_Frequency;
 
    //! @brief Duty setpoint
    TBlock_Input_Connector object_f32_Duty;
 
    //! @brief Temperature gain calibration
    TBlock_Input_Connector object_f32_Temperature_Gain;
 
    //! @brief Temperature offset calibration
    TBlock_Input_Connector object_f32_Temperature_Offset;
 
    TBlock_Input_Connector object_f32_Positive_Current_Magnitude;
    TBlock_Input_Connector object_f32_Negative_Current_Magnitude;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Actual modulator temperature as raw data
    TBlock_Output_Connector object_u16_Temperature_Raw_Data;
 
    //! @brief Actual modulator temperature in gradus celsius
    TBlock_Output_Connector object_f32_Temperature;
 
  //----------------------------------------------------------------------------
  // Protected defines, variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, variables and methods
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief NTC sensor object
    TNTC object_NTC;
 
    //! @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 modulator ( 0 - Disabled, 1 - Enabled )
        U16 bit1_Enable_Modulator:1;
 
        //! @brief Bit 1 : Enable PWM output T1 ( 0 - Disabled, 1 - Enabled )
        U16 bit1_Enable_Output_T1:1;
 
        //! @brief Bit 2 : Enable PWM output T2 ( 0 - Disabled, 1 - Enabled )
        U16 bit1_Enable_Output_T2:1;
 
        //! @brief Bit 3 : Enable PWM output T3 ( 0 - Disabled, 1 - Enabled )
        U16 bit1_Enable_Output_T3:1;
 
        //! @brief Bit 4 : Enable PWM output T4 ( 0 - Disabled, 1 - Enabled )
        U16 bit1_Enable_Output_T4:1;
 
        //! @brief Bit 5 : Enable gate driver ( 0 - Disabled, 1 - Enabled )
        U16 bit1_Enable_Driver:1;
 
        //! @brief Bits 6..15 : Reserved
        U16 bit10_Reserved:10;
 
      };
 
    } TControl_Register;
 
    //! @brief Status register structure
    typedef struct
    {
 
      //! @brief Temperature data valid ( 0 - Data invalid, 1 - Data valid)
      U16 bit1_Temperature_Data_Valid:1;
 
      //! @brief Bits 1..15 : Reserved
      U16 bit15_Reserved_1:15;
 
    } TStatus_Register;
 
    //! @brief FPGA mapped registers
    volatile TP019_11_KG3_MOD_Registers *struct_Registers;
 
    //! @brief Clock cycle per period as float point number
    F64 f64_Cycles;
    
    //! @brief Clock cycle per on state as float point number
    F64 f64_On_Cycles;
    
    //! @brief Clock cycle per off state as float point number
    F64 f64_Off_Cycles;
 
    U32 u32_Cycles;
    U32 u32_On_Cycles;
    U16 u16_On_Cycles_L;
    U16 u16_On_Cycles_H;
    U32 u32_Off_Cycles;
    U16 u16_Off_Cycles_L;
    U16 u16_Off_Cycles_H;
 
    //! @brief Temperature value
    F32 f32_Temperature;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------