PWM_3P3L.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      PWM_3P3L.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      03.05.2015
//! @brief     3-phase 3-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.
//------------------------------------------------------------------------------
  
//------------------------------------------------------------------------------
// 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 3-phase 3-level pulse width modulator object class
//------------------------------------------------------------------------------
 
class TPWM_3P3L : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    // Register structure for generic access
    typedef struct
    {
      
      union
      {
        U16 u16_Control;  //!< PWM module control register
        U16 u16_Status;   //!< PWM module status register
      };
      
      U16 u16_Half_Periode;  //!< Half PWM periode register
      U16 u16_Dead_Time;     //!< Dead time register 
      
      U16 u16_Reserve;
      
      I16 i16_Setpoint_L1_1;  //!< Set point 1 of the phase 1 
      I16 i16_Setpoint_L1_2;  //!< Set point 2 of the phase 1 
      I16 i16_Setpoint_L2_1;  //!< Set point 1 of the phase 2 
      I16 i16_Setpoint_L2_2;  //!< Set point 2 of the phase 2 
      I16 i16_Setpoint_L3_1;  //!< Set point 1 of the phase 3 
      I16 i16_Setpoint_L3_2;  //!< Set point 2 of the phase 3 
 
      // PWM Setpoint registers
/*
      // ANVILEX: To remove
      U16 i16_Setpoint_P1_T1; //!< Setpoint for phase 1 switch T1
      U16 i16_Setpoint_P1_T2; //!< Setpoint for phase 1 switch T2
      U16 i16_Setpoint_P1_T3; //!< Setpoint for phase 1 switch T3
      U16 i16_Setpoint_P1_T4; //!< Setpoint for phase 1 switch T4
 
      U16 i16_Setpoint_P2_T1; //!< Setpoint for phase 2 switch T1
      U16 i16_Setpoint_P2_T2; //!< Setpoint for phase 2 switch T2
      U16 i16_Setpoint_P2_T3; //!< Setpoint for phase 2 switch T3
      U16 i16_Setpoint_P2_T4; //!< Setpoint for phase 2 switch T4
 
      U16 i16_Setpoint_P3_T1; //!< Setpoint for phase 3 switch T1
      U16 i16_Setpoint_P3_T2; //!< Setpoint for phase 3 switch T2
      U16 i16_Setpoint_P3_T3; //!< Setpoint for phase 3 switch T3
      U16 i16_Setpoint_P3_T4; //!< Setpoint for phase 3 switch T4
*/
 
    } TPWM_3P3L_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TPWM_3P3L();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TPWM_3P3L();
 
    //!-------------------------------------------------------------------------
    //! @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_3P3L_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();
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    // Inputs
    F32 *f32_Magnitude;    // [-]   Magnitude of the voltage vector
    F32 *f32_Angle;        // [rad] Angle of the voltage vector
    F32 *f32_Output_Power; // [?]   Output power (requered for correct d.c. bus balancing)
    
    F32 *f32_DC_Voltage_Top;     // [V]
    F32 *f32_DC_Voltage_Bottom;  // [V]
 
    F32 *f32_Output_Current_L1; // [-] Output current phase L1
    F32 *f32_Output_Current_L2; // [-] Output current phase L2
    F32 *f32_Output_Current_L3; // [-] Output current phase L3
 
    F32 *f32_Maximum_Modulation_Factor; // [-]
 
//    U16 *u16_Half_Period;
//    U16 *u16_Dead_Time;
    
    // Outputs
    F32 f32_Duty_L1_Top;
    F32 f32_Duty_L1_Bottom;
    F32 f32_Duty_L2_Top;
    F32 f32_Duty_L2_Bottom;
    F32 f32_Duty_L3_Top;
    F32 f32_Duty_L3_Bottom;
    
    F32 f32_Clock_Frequency;
    F32 f32_Switching_Frequency;
 
    F32 f32_Sample_Time;
 
    U16 u16_Period;
    U16 u16_Half_Period;
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
    
  private:
  
    //! @brief FPGA mapped registers
    TPWM_3P3L_Registers *struct_Registers;  
 
};
 
//------------------------------------------------------------------------------
// Export references to the objects
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Export references to the functions
//------------------------------------------------------------------------------
  
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------