PWM_2C3P2L.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      PWM_2C3P2L.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      03.05.2016
//! @brief     3-phase 2-level pulse width modulator object header file.
//! @attention
//!
//! COPYRIGHT(C) 2015 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.
//------------------------------------------------------------------------------
//
// TPWM_3P2L_T1
// TPWM_3P2L -  used in DFIG project
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Application_Resource_Configuration.h"
#include "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Check requered includes
//------------------------------------------------------------------------------
 
//#ifndef __APPLICATION_RESOURCE_CONFIGURATION_H
//#error "System resourse configuration file not included."
//#endif
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//! @brief 3-phase 2-level pulse width modulator type 1 object class
class TPWM_3P2L_T1 : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    // Register structure for generic access
    typedef struct
    {
      
      // Control and status registars
      union
      {
        U16 u16_Control;  //!< Offset 0x00, Twin PWM module control register
        U16 u16_Status;   //!< Offset 0x00, Twin PWM module status register
      };
      
      // Configuration registers
      union
      {
        U16 u16_Half_Periode;           //!< Offset 0x01, Half PWM periode register
        U16 u16_Status_Latch;           //!< Offset 0x01, Status register latch
      };
      U16 u16_Dead_Time_Inverter_1;   //!< Offset 0x02, Dead time register of the inverter 1
      U16 u16_Dead_Time_Inverter_2;   //!< Offset 0x03, Dead time register of the inverter 2 
            
      // Inverter 1 PWM setpoint registers
      I16 i16_Setpoint_Inverter_1_L1; //!< Offset 0x04, Set point of the inverter 1 leg 1 
      I16 i16_Setpoint_Inverter_1_L2; //!< Offset 0x05, Set point of the inverter 1 leg 2 
      I16 i16_Setpoint_Inverter_1_L3; //!< Offset 0x06, Set point of the inverter 1 leg 3 
      U16 u16_Reserve_7; //!< Offset 0x07, Not used
 
      // Inverter 2 PWM Setpoint registers
      I16 i16_Setpoint_Inverter_2_L1; //!< Offset 0x08, Set point of the inverter 2 leg 1 
      I16 i16_Setpoint_Inverter_2_L2; //!< Offset 0x09, Set point of the inverter 2 leg 2 
      I16 i16_Setpoint_Inverter_2_L3; //!< Offset 0x0A, Set point of the inverter 2 leg 3 
      U16 u16_Reserve_B; //!< Offset 0x0B, Not used
 
      // Reserved registers
      U16 u16_Reserve_C; //!< Offset 0x0C, Not used
      U16 u16_Reserve_D; //!< Offset 0x0D, Not used
      U16 u16_Reserve_E; //!< Offset 0x0E, Not used
      U16 u16_Reserve_F; //!< Offset 0x0F, Not used
 
    } TPWM_3P2L_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    TPWM_3P2L_T1(); //!< Constructor method
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TPWM_3P2L_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     3-phase 3-level pulse width modulator memory mapping.
    //! @note      None
    //! @param     [in] struct_Registers_Base_Address Base address within FPGA address space
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TPWM_3P2L_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
    
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      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 );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    // Parameters
 
    TBlock_Input_Connector object_f32_Switching_Frequency;  // [Hz] PWM carrier frequency
 
    // Inputs
 
    TBlock_Input_Connector object_bool_Enable_Inverter_1; // Enable inverter 1
    TBlock_Input_Connector object_bool_Enable_Inverter_2; // Enable inverter 2
 
    TBlock_Input_Connector object_u16_Inverter_1_Phase_L1_Setpoint; // [-] Output voltage setpoint inverter 1 phase L1
    TBlock_Input_Connector object_u16_Inverter_1_Phase_L2_Setpoint; // [-] Output voltage setpoint inverter 1 phase L2
    TBlock_Input_Connector object_u16_Inverter_1_Phase_L3_Setpoint; // [-] Output voltage setpoint inverter 1 phase L3
 
    TBlock_Input_Connector object_u16_Inverter_2_Phase_L1_Setpoint; // [V] Output voltage setpoint inverter 2 phase L1
    TBlock_Input_Connector object_u16_Inverter_2_Phase_L2_Setpoint; // [V] Output voltage setpoint inverter 2 phase L2
    TBlock_Input_Connector object_u16_Inverter_2_Phase_L3_Setpoint; // [V] Output voltage setpoint inverter 2 phase L3
 
    //--------------------------------------------------------------------------
    // Outputs    
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_f32_Sample_Time;     // [s] Control event sample time
 
    TBlock_Output_Connector object_bool_Inverter_1_Hardware_Fault; //!< Inverter 1 hardware fault
    TBlock_Output_Connector object_bool_Inverter_2_Hardware_Fault; //!< Inverter 2 hardware fault
 
    //--------------------------------------------------------------------------
    // Diagnose outputs
    //--------------------------------------------------------------------------
    
    #ifdef FUNCTIONAL_BLOCK_CREATE_DIAGNOSE_OUTPUTS
  
    U16 u16_Control;
 
    #endif
    
  //----------------------------------------------------------------------------
  // Protected variables and methods
  //----------------------------------------------------------------------------
    
  protected:
 
  //----------------------------------------------------------------------------
  // Private variables and methods
  //----------------------------------------------------------------------------
  
  private:
  
    TPWM_3P2L_Registers *struct_Registers;  //!< FPGA mapped registers
 
    F32 f32_Clock_Frequency;      //!< [Hz] FPGA system clock
    U16 u16_Periode;              //!< [Counts] Periode in counts
    U16 u16_Half_Periode;         //!< [Counts] Half periode in counts
    U16 u16_Quarter_Periode;      //!< [Counts] Quarter periode
 
    U16 u16_Inverter_1_Deadtime; //!< Inverter 1 deadtime in FPGA clock counts
    U16 u16_Inverter_2_Deadtime; //!< Inverter 2 deadtime in FPGA clock counts
 
};
 
//------------------------------------------------------------------------------
 
//! @brief 3-phase 2-level pulse width modulator object class
class TPWM_3P2L : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    // Register structure for generic access
    typedef struct
    {
      
      // Control and status registars
      union
      {
        U16 u16_Control;  //!< Offset 0x00, Twin PWM module control register
        U16 u16_Status;   //!< Offset 0x00, Twin PWM module status register
      };
      
      // Configuration registers
      union
      {
        U16 u16_Half_Periode;           //!< Offset 0x01, Half PWM periode register
        U16 u16_Status_Latch;           //!< Offset 0x01, Status register latch
      };
      U16 u16_Dead_Time_Inverter_1;   //!< Offset 0x02, Dead time register of the inverter 1
      U16 u16_Dead_Time_Inverter_2;   //!< Offset 0x03, Dead time register of the inverter 2 
            
      // Inverter 1 PWM setpoint registers
      I16 i16_Setpoint_Inverter_1_L1; //!< Offset 0x04, Set point of the inverter 1 leg 1 
      I16 i16_Setpoint_Inverter_1_L2; //!< Offset 0x05, Set point of the inverter 1 leg 2 
      I16 i16_Setpoint_Inverter_1_L3; //!< Offset 0x06, Set point of the inverter 1 leg 3 
      U16 u16_Reserve_7; //!< Offset 0x07, Not used
 
      // Inverter 2 PWM Setpoint registers
      I16 i16_Setpoint_Inverter_2_L1; //!< Offset 0x08, Set point of the inverter 2 leg 1 
      I16 i16_Setpoint_Inverter_2_L2; //!< Offset 0x09, Set point of the inverter 2 leg 2 
      I16 i16_Setpoint_Inverter_2_L3; //!< Offset 0x0A, Set point of the inverter 2 leg 3 
      U16 u16_Reserve_B; //!< Offset 0x0B, Not used
 
      // Reserved registers
      U16 u16_Reserve_C; //!< Offset 0x0C, Not used
      U16 u16_Reserve_D; //!< Offset 0x0D, Not used
      U16 u16_Reserve_E; //!< Offset 0x0E, Not used
      U16 u16_Reserve_F; //!< Offset 0x0F, Not used
 
    } TPWM_3P2L_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TPWM_3P2L(); //!< Constructor method
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TPWM_3P2L();
 
    //!-------------------------------------------------------------------------
    //! @brief     3-phase 3-level pulse width modulator memory mapping.
    //! @note      None
    //! @param     [in] struct_Registers_Base_Address Base address within FPGA address space
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TPWM_3P2L_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
    
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      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 );
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    // Parameters
 
    TBlock_Input_Connector object_f32_Switching_Frequency;  // [Hz] PWM carrier frequency
 
    // Inputs
 
    TBlock_Input_Connector object_bool_Enable_Inverter_1; // Enable inverter 1
    TBlock_Input_Connector object_bool_Enable_Inverter_2; // Enable inverter 2
 
    TBlock_Input_Connector object_f32_Inverter_1_Phase_L1_Voltage;  // [V] Output voltage inverter 1 phase L1
    TBlock_Input_Connector object_f32_Inverter_1_Phase_L2_Voltage;  // [V] Output voltage inverter 1 phase L2
    TBlock_Input_Connector object_f32_Inverter_1_Phase_L3_Voltage;  // [V] Output voltage inverter 1 phase L3
 
    TBlock_Input_Connector object_f32_Inverter_2_Phase_L1_Voltage;  // [V] Output voltage inverter 2 phase L1
    TBlock_Input_Connector object_f32_Inverter_2_Phase_L2_Voltage;  // [V] Output voltage inverter 2 phase L2
    TBlock_Input_Connector object_f32_Inverter_2_Phase_L3_Voltage;  // [V] Output voltage inverter 2 phase L3
 
    TBlock_Input_Connector object_f32_DC_Bus_Voltage;   // [V] d.c. bus voltage
 
    //--------------------------------------------------------------------------
    // Outputs    
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_f32_Sample_Time;     // [s] Control event sample time
 
    TBlock_Output_Connector object_bool_Inverter_1_Hardware_Fault; //!< Inverter 1 hardware fault
    TBlock_Output_Connector object_bool_Inverter_2_Hardware_Fault; //!< Inverter 2 hardware fault
 
    //--------------------------------------------------------------------------
    // Diagnose outputs
    //--------------------------------------------------------------------------
    
    #ifdef FUNCTIONAL_BLOCK_CREATE_DIAGNOSE_OUTPUTS
      
    F32 f32_K;
 
    F32 f32_Inverter_1_Phase_L1_Time;
    F32 f32_Inverter_1_Phase_L2_Time;
    F32 f32_Inverter_1_Phase_L3_Time;
  
    I32 f32_Inverter_2_Phase_L1_Time;
    I32 f32_Inverter_2_Phase_L2_Time;
    I32 f32_Inverter_2_Phase_L3_Time;
 
    F32 f32_Inverter_1_Minimum_Time;
    F32 f32_Inverter_1_Maximum_Time;
    
    F32 f32_Inverter_2_Minimum_Time;
    F32 f32_Inverter_2_Maximum_Time;
 
    F32 f32_Inverter_1_Offset;
    F32 f32_Inverter_2_Offset;
 
    I32 i32_Inverter_1_Phase_L1_Setpoint;
    I32 i32_Inverter_1_Phase_L2_Setpoint;
    I32 i32_Inverter_1_Phase_L3_Setpoint;
 
    I32 i32_Inverter_2_Phase_L1_Setpoint;
    I32 i32_Inverter_2_Phase_L2_Setpoint;
    I32 i32_Inverter_2_Phase_L3_Setpoint;
 
    U16 u16_Control;
 
    #endif
    
  //----------------------------------------------------------------------------
  // Protected defines, variables and methods
  //----------------------------------------------------------------------------
    
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, variables and methods
  //----------------------------------------------------------------------------
  
  private:
  
    TPWM_3P2L_Registers *struct_Registers;  //!< FPGA mapped registers
 
    F32 f32_Clock_Frequency;      //!< [Hz] FPGA system clock
    U16 u16_Periode;              //!< [Counts] Periode in counts
    U16 u16_Half_Periode;         //!< [Counts] Half periode in counts
    U16 u16_Quarter_Periode;      //!< [Counts] Quarter periode
 
    U16 u16_Inverter_1_Deadtime; //!< Inverter 1 deadtime in FPGA clock counts
    U16 u16_Inverter_2_Deadtime; //!< Inverter 2 deadtime in FPGA clock counts
  
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------