P018_39_KG3_BLA_E.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P018_39_KG3_BLA.h
//! @brief      KG3 Electronic load device adapter board P018.39 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/P018_39_KG3_BLA/P018_39_KG3_BLA.h $
//!             $Revision: 2305 $
//!             $Date: 2020-12-25 03:00:01 +0500 (Пт, 25 дек 2020) $
//!             $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.
//
//------------------------------------------------------------------------------
//
// TP018_39_KG3_BLA_T1_E
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "NTCT_Sensor.h"
#include "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//! @brief Electronic load device adapter KG3 BLA T1 (P018.39) board class
class TP018_39_KG3_BLA_T1_E : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    // Register structure for generic access
    typedef struct
    {
 
      //------------------------------------------------------------------------
      // Unit identification registers
      //------------------------------------------------------------------------
      
      //! @brief 0x00 : Module identification register
      U16 u16_Unit_ID_L;            
      
      //! @brief 0x01 : Module identification register
      U16 u16_Unit_ID_H;            
 
      //------------------------------------------------------------------------
      
      //! @brief 0x02 : Reserved register
      U16 u16_Unused_0x02;          
      
      //! @brief 0x03 : Reserved register
      U16 u16_Unused_0x03;          
 
      //! @brief 0x04 : DAC data
      U16 u16_DAC_Data;             
      
      //! @brief 0x05 : Reserved register
      U16 u16_Unused_0x05;          
      
      //! @brief 0x06 : Reserved register
      U16 u16_Unused_0x06;          
      
      //! @brief 0x07 : Reserved register
      U16 u16_Unused_0x07;          
 
      //! @brief 0x08 : Control and status registers
      union
      {
        
        //! @brief 0x08 Status register
        U16 u16_ADC_Status;         
        
        //! @brief 0x08 Control register
        U16 u16_ADC_Control;        
        
      };
      
      //! @brief 0x09 : ADC channel 1 data register as U16 value
      U16 u16_ADC_Data_1;           
      
      //! @brief 0x0A : ADC channel 2 data register as U16 value
      U16 u16_ADC_Data_2;           
      
      //! @brief 0x0B : ADC channel 3 data register as U16 value
      U16 u16_ADC_Data_3;           
      
      //! @brief 0x0C : ADC channel 1 filtered data register as U16 value
      U16 u16_ADC_Filtered_Data_1;  
      
      //! @brief 0x0D : ADC channel 2 filtered data register as U16 value
      U16 u16_ADC_Filtered_Data_2;  
      
      //! @brief 0x0E : ADC channel 3 filtered data register as U16 value
      U16 u16_ADC_Filtered_Data_3;  
 
      //! @brief 0x0F : Reserved register
      U16 u16_Unused_0x0F;          
 
      //! @brief 0x10 : Fan status register
      U16 u16_Fan_Status;           
      
      //! @brief 0x11 : Fan control register
      U16 u16_Fan_Control;          
 
      //! @brief 0x12 : Fan speed setpoint
      U16 u16_Fan_Speed_Setpoint;   
          
      //! @brief 0x13 : Fan speed carrier period channel 1
      U16 u16_Fan_Speed_Status_Carrier_Period_1;    
      
      //! @brief 0x14 : Fan speed carrier period channel 2
      U16 u16_Fan_Speed_Status_Carrier_Period_2;    
      
      //! @brief 0x15 : Fan speed carrier period channel 3
      U16 u16_Fan_Speed_Status_Carrier_Period_3;    
      
      //! @brief 0x16 : Fan speed carrier period channel 4
      U16 u16_Fan_Speed_Status_Carrier_Period_4;    
      
      //! @brief 0x17 : Fan speed carrier period channel 5
      U16 u16_Fan_Speed_Status_Carrier_Period_5;    
      
      //! @brief 0x18 : Fan speed carrier period channel 6
      U16 u16_Fan_Speed_Status_Carrier_Period_6;    
      
      //! @brief 0x19 : Fan speed carrier period channel 7
      U16 u16_Fan_Speed_Status_Carrier_Period_7;    
      
      //! @brief 0x1A : Fan speed carrier period channel 8
      U16 u16_Fan_Speed_Status_Carrier_Period_8;    
      
      //! @brief 0x1B : Fan speed carrier period channel 9
      U16 u16_Fan_Speed_Status_Carrier_Period_9;  
 
      //! @brief 0x1C : Fan speed carrier period channel 10
      U16 u16_Fan_Speed_Status_Carrier_Period_10; 
      
      //! @brief 0x1D : Fan speed carrier period channel 11
      U16 u16_Fan_Speed_Status_Carrier_Period_11; 
      
      //! @brief 0x1E : Fan speed carrier period channel 12     
      U16 u16_Fan_Speed_Status_Carrier_Period_12; 
 
    } TP018_39_KG3_BLA_Registers;
    
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP018_39_KG3_BLA_T1_E();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP018_39_KG3_BLA_T1_E();
 
    VOID Map( TP018_39_KG3_BLA_Registers *struct_Registers_Base_Address ); //!< Hardware map method
    virtual VOID Init(); //!< Block initialisation method
    virtual VOID Execute(); //!< Block execution method
    virtual VOID Send_Information( TProtocol_Base *object_Protocol ); //!< Send information method
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //! @brief Analog input channel 1 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_1; 
 
    //! @brief Analog input channel 1 gain
    TBlock_Input_Connector object_f32_Analog_Input_Gain_1; 
 
    //! @brief Analog input channel 2 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_2; 
    
    //! @brief Analog input channel 2 gain
    TBlock_Input_Connector object_f32_Analog_Input_Gain_2; 
 
    //! @brief Analog input channel 3 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_3; 
 
    //! @brief Analog input channel 3 gain
    TBlock_Input_Connector object_f32_Analog_Input_Gain_3; 
 
    //! @brief Fan speed PWM carrier frequency
    TBlock_Input_Connector object_f32_Fan_Speed_Control_PWM_Carrier_Frequency;
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    //! @brief Output current setpoint
    //! @note Acceptable signal range 0.0-1.0
    TBlock_Input_Connector object_f32_Output_Current_Setpoint; 
 
    //! @brief Fan speed setpoint
    //! @note Acceptable signal range 0.0-1.0
    TBlock_Input_Connector object_f32_Fan_Speed_Setpoint;
    
    //! @brief Load board voltage
    //! @note Acceptable signal range 0.0-105.0
    TBlock_Input_Connector object_f32_Load_Board_Voltage;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Analog input status
    TBlock_Output_Connector object_u16_Analog_Input_Status; 
 
    //! @brief Analog input channel 1 block output as I16
    TBlock_Output_Connector object_u16_Analog_Input_Raw_Data_1; 
    
    //! @brief Analog input channel 2 block output as I16
    TBlock_Output_Connector object_u16_Analog_Input_Raw_Data_2; 
    
    //! @brief Analog input channel 3 block output as I16
    TBlock_Output_Connector object_u16_Analog_Input_Raw_Data_3; 
 
    //! @brief Analog input channel 1 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_1; 
    
    //! @brief Analog input channel 2 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_2; 
    
    //! @brief Analog input channel 3 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_3;
    
    //! @brief Analog power output
    TBlock_Output_Connector object_f32_Analog_Power; 
    
    //! @brief Critical hardware error flag
    TBlock_Output_Connector object_bool_Hardware_Error; 
    
    //! @brief Speed of cooling fan 1
    TBlock_Output_Connector object_f32_Fan_Speed_1;
    
    //! @brief Speed of cooling fan 2
    TBlock_Output_Connector object_f32_Fan_Speed_2;
    
    //! @brief Speed of cooling fan 3
    TBlock_Output_Connector object_f32_Fan_Speed_3;
    
    //! @brief Speed of cooling fan 4
    TBlock_Output_Connector object_f32_Fan_Speed_4;
    
    //! @brief Speed of cooling fan 5
    TBlock_Output_Connector object_f32_Fan_Speed_5;
    
    //! @brief Speed of cooling fan 6
    TBlock_Output_Connector object_f32_Fan_Speed_6;
    
    //! @brief Speed of cooling fan 7
    TBlock_Output_Connector object_f32_Fan_Speed_7;
    
    //! @brief Speed of cooling fan 8
    TBlock_Output_Connector object_f32_Fan_Speed_8;
    
    //! @brief Speed of cooling fan 9
    TBlock_Output_Connector object_f32_Fan_Speed_9;
    
    //! @brief Speed of cooling fan 10
    TBlock_Output_Connector object_f32_Fan_Speed_10;
    
    //! @brief Speed of cooling fan 11
    TBlock_Output_Connector object_f32_Fan_Speed_11;
    
    //! @brief Speed of cooling fan 12
    TBlock_Output_Connector object_f32_Fan_Speed_12;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
  
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
 
    typedef union
    {
      U16 u16_Status;
      struct
      {
        U16 u16_ADC_Hardware_Fault_1:1; // Bit 0
        U16 u16_ADC_Hardware_Fault_2:1; // Bit 1
        U16 u16_ADC_Hardware_Fault_3:1; // Bit 2
        U16 :1; // Bit 3
        U16 :1; // Bit 4
        U16 :1; // Bit 5
        U16 :1; // Bit 6
        U16 :1; // Bit 7
        U16 :1; // Bit 8
        U16 :1; // Bit 9
        U16 :1; // Bit 10
        U16 :1; // Bit 11
        U16 :1; // Bit 12
        U16 :1; // Bit 13
        U16 :1; // Bit 14
        U16 :1; // Bit 15
      };
    } TStatus;
 
    typedef union
    {
      U16 u16_Status;
      struct
      {
        U16 u16_Speed_Status_Carrier_Period_Channel_1_Valid:1; // Bit 0
        U16 u16_Speed_Status_Carrier_Period_Channel_2_Valid:1; // Bit 1
        U16 u16_Speed_Status_Carrier_Period_Channel_3_Valid:1; // Bit 2
        U16 u16_Speed_Status_Carrier_Period_Channel_4_Valid:1; // Bit 3
        U16 u16_Speed_Status_Carrier_Period_Channel_5_Valid:1; // Bit 4
        U16 u16_Speed_Status_Carrier_Period_Channel_6_Valid:1; // Bit 5
        U16 u16_Speed_Status_Carrier_Period_Channel_7_Valid:1; // Bit 6
        U16 u16_Speed_Status_Carrier_Period_Channel_8_Valid:1; // Bit 7
        U16 u16_Speed_Status_Carrier_Period_Channel_9_Valid:1; // Bit 8
        U16 u16_Speed_Status_Carrier_Period_Channel_10_Valid:1; // Bit 9
        U16 u16_Speed_Status_Carrier_Period_Channel_11_Valid:1; // Bit 10
        U16 u16_Speed_Status_Carrier_Period_Channel_12_Valid:1; // Bit 11
        U16 :1; // Bit 12
        U16 :1; // Bit 13
        U16 :1; // Bit 14
        U16 :1; // Bit 15
      };
    } TFan_Status;
 
    volatile TP018_39_KG3_BLA_Registers *struct_Registers; //!< Hardware mapped registers
 
    F32 f32_DAC_Gain;   //!< Effective gain of the DAC channel
    F32 f32_DAC_Offset; //!< Effective offset of the DAC channel
    
    F32 f32_ADC_Gain_1; //!< Effective gain of the ADC channel 1
    F32 f32_ADC_Gain_2; //!< Effective gain of the ADC channel 2
    F32 f32_ADC_Gain_3; //!< Effective gain of the ADC channel 3
 
    F32 f32_ADC_Offset_1; //!< Effective offset of the ADC channel 1
    F32 f32_ADC_Offset_2; //!< Effective offset of the ADC channel 2
    F32 f32_ADC_Offset_3; //!< Effective offset of the ADC channel 3
 
    F32 f32_PWM_Maximum_Setpoint;
    
    F32 f32_Fan_Speed_PWM_Setpoint;
    
    F32 f32_Fan_Speed_1;
    F32 f32_Fan_Speed_2;
    F32 f32_Fan_Speed_3;
    F32 f32_Fan_Speed_4;
    F32 f32_Fan_Speed_5;
    F32 f32_Fan_Speed_6;
    F32 f32_Fan_Speed_7;
    F32 f32_Fan_Speed_8;
    F32 f32_Fan_Speed_9;
    F32 f32_Fan_Speed_10;
    F32 f32_Fan_Speed_11;
    F32 f32_Fan_Speed_12;
 
    //! @brief NTC sensor object
    TNTC object_NTC;
 
    F32 f32_DAC_Data;
    U16 u16_DAC_Data;
 
    F32 f32_Uadc;
    F32 f32_IR707;
    F32 f32_IR108;
    F32 f32_UR108;
    F32 f32_R108;
    F32 f32_Temperature;
    
    
    //! @brief Load board model private variables
    
    //! @brief Load board resistance
    F64 f64_Load_Board_Resistance;
    
    //! @brief Fan impeller diameter 
    F64 f64_Fan_Diameter;
    
    //! @brief Equivalent hydraulic diameter of board-to-board channel 
    F64 f64_Eqv_Hyd_Diameter;
    
    //! @brief Load board surface area
    F64 f64_Load_Board_Area;
    
    //! @brief Load board material coefficient of thermal conductivity
    F64 f64_Load_Board_CTC;
    
    //! @brief Load board mass
    F64 f64_Load_Board_Mass;
    
    //! @brief Variable for storing current setpoint value
    F64 f64_Current_Setpoint;
    
    //! @brief Air temperature
    F64 f64_Air_Temperature;
    
    //! @brief Load board temperature
    F64 f64_Load_Board_Temperature;
    
    //! @brief Load board temperature increment
    F64 f64_Load_Board_Temperature_Inc;
    
    //! @brief Variable for storing fan speed reference value
    F64 f64_Fan_Speed_Ref;
    
    //! @brief Air speed generated by the fan 
    F64 f64_Air_Speed;
    
    //! @brief Average air speed at the entrance to the board-to-board channel 
    F64 f64_Air_Speed_Average;
    
    //! @brief Effective airflow rate when entering the board-to-board channel 
    F64 f64_Air_Speed_Effective;
 
    //! @brief Reinolds number
    F64 f64_Re;
    
    //! @brief Nusselt number;
    F64 f64_Nu;
    
    //! @brief Heat transfer coefficient at the entrance to the channel 
    F64 f64_HTC;
    
    //! @brief Thermal resistance to the ambient
    F64 f64_R_Ambient;
 
    //! @brief Thermal resistance to the load board
    F64 f64_R_Load_Board;
    
    //! @brief Variable for storing load board current value
    F64 f64_Load_Board_Current;
    
    //! @brief Variable for storing load board voltage value
    F64 f64_Load_Board_Voltage;
    
    //! @brief Depth of the load board;
    F64 f64_Load_Board_Depth;
    
    //! @brief Fan time constant 
    F64 f64_Fan_Tau;
    
    //! @brief
    F64 f64_Fan_Speed_Calc;
        
    
    //! @brief Load board model private methods
    
    //!-------------------------------------------------------------------------
    //! @brief     Calculate value of the mosfet transistor resistance 
    //! @note      -
    //! @param     [in] F64& _f64_Current_Setpoint - Reference to the current setpoint variable
    //! @return    [out] Value of the mosfet tronsistor resistance
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    F64 f64_Mosfer_Resistance(F64& _f64_Current_Setpoint);
    
    //!-------------------------------------------------------------------------
    //! @brief     Calculate value of the kinematic viscosity of the air 
    //! @note      -
    //! @param     [in] F64& _f64_Air_Temperature - Reference to the air temperature variable
    //! @return    [out] Value of the kinematic viscosity of the air
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    F64 f64_Air_Kinematic_Viscosity(F64& _f64_Air_Temperature);
    
    //!-------------------------------------------------------------------------
    //! @brief     Calculate value of the load board temperature
    //! @note      -
    //! @param     [in] F64& _f64_Load_Board_Temperature - Reference to the variable storing the temperature value of the load board
    //! @return    [out] Value of the specific thermal capasity coefficient of the load board material
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    F64 f64_Load_Board_Specific_TCC(F64& _f64_Load_Board_Temperature);
    
    //!-------------------------------------------------------------------------
    //! @brief     Calculate value of the fan speed
    //! @note      -
    //! @param     [in] F64& _f64_Fan_Speed_Ref - Reference to the variable storing the reference fan speed value
    //! @return    [out] Value of the specific thermal capasity coefficient of the load board material
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    F64 f64_Fan_Speed(F64& _f64_Fan_Speed_Ref);
    
    //!-------------------------------------------------------------------------
    //! @brief     Calculate value of the coefficient of thermal conductivity of the air
    //! @note      -
    //! @param     [in] F64& _f64_Air_Temperature - Reference to the variable storing the air temperature value
    //! @return    [out] Value of the thermal conductivity of the air
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    F64 f64_Air_CTC(F64& _f64_Air_Temperature);
 
};
  
//------------------------------------------------------------------------------
// End of file 
//------------------------------------------------------------------------------