P017_66_KG3_FAN.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P017_66_KG3_FAN.h
//! @brief      KG3 Fan I/O board P017.66 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/P017_66_KG3_FAN/P017_66_KG3_FAN.h $
//!             $Revision: 2305 $
//!             $Date: 2020-12-25 03:00:01 +0500 (Fr, 25 Dez 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.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Functional_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
 
//! @brief Fan input/output interface board P017.66 class
class TP017_66_KG3_FAN : public TFunctional_Block_Base
{
 
  //--------------------------------------------------------------------------
  // Public defines, methods and variables
  //--------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public type declarations
    //--------------------------------------------------------------------------
 
    //! @brief Register structure for fan I/O access
    typedef struct
    {
 
      //! @brief 0x00 : Unit identification register
      U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Unit identification register
      U16 u16_Unit_ID_H;
 
      //! @brief Control and status registers
      union
      {
 
        //! @brief 0x02 : Status register
        U16 u16_Status;
 
        //! @brief 0x02 : Control register
        U16 u16_Control;
 
      };
 
      //! @brief 0x03 : Fan supply PWM period register
      U16 u16_Supply_PWM_Period;
 
      //! @brief 0x04 : Fan supply PWM positive half period register
      U16 u16_Supply_PWM_Positive_Half_Period;
 
      //! @brief 0x05 : Fan supply PWM negative half period register
      U16 u16_Supply_PWM_Negative_Half_Period;
 
      //! @brief 0x06 : Fan speed control PWM carrier period for channel 1
      U16 u16_Fan_Speed_Control_PWM_Period_Channel_1;
 
      //! @brief 0x07 : Fan speed control PWM carrier period for channel 2
      U16 u16_Fan_Speed_Control_PWM_Period_Channel_2;
 
      //! @brief 0x08 : Fan speed control PWM carrier period for channel 3
      U16 u16_Fan_Speed_Control_PWM_Period_Channel_3;
 
      //! @brief 0x09 : Fan speed control PWM setpoint for channel 1
      U16 u16_Fan_Speed_Control_PWM_Setpoint_Channel_1;
 
      //! @brief 0x0A : Fan speed control PWM setpoint for channel 2
      U16 u16_Fan_Speed_Control_PWM_Setpoint_Channel_2;
 
      //! @brief 0x0B : Fan speed control PWM setpoint for channel 3
      U16 u16_Fan_Speed_Control_PWM_Setpoint_Channel_3;
 
      //! @brief 0x0C : Fan speed frequency period for channel 1
      U16 u16_Fan_Speed_Status_Period_Channel_1;
 
      //! @brief 0x0D : Fan speed frequency period for channel 2
      U16 u16_Fan_Speed_Status_Period_Channel_2;
 
      //! @brief 0x0E : Fan speed frequency period for channel 3
      U16 u16_Fan_Speed_Status_Period_Channel_3;
 
    } TP017_66_KG3_FAN_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP017_66_KG3_FAN();
    
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TP017_66_KG3_FAN();
 
    //!-------------------------------------------------------------------------
    //! @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( TP017_66_KG3_FAN_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(); 
    
    VOID Execute_Inputs();
 
    VOID Execute_Outputs();
    
    //!-------------------------------------------------------------------------
    //! @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 parameter inputs
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Speed_Control_PWM_Carrier_Frequency_Channel_1;
    TBlock_Input_Connector object_f32_Speed_Control_PWM_Carrier_Frequency_Channel_2;
    TBlock_Input_Connector object_f32_Speed_Control_PWM_Carrier_Frequency_Channel_3;
 
    //--------------------------------------------------------------------------
    // Function block input signals
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_bool_Supply_Enable;
 
    TBlock_Input_Connector object_bool_Fan_Enable_1;
    TBlock_Input_Connector object_bool_Fan_Enable_2;
    TBlock_Input_Connector object_bool_Fan_Enable_3;
 
    TBlock_Input_Connector object_f32_Fan_Speed_Setpoint_1;
    TBlock_Input_Connector object_f32_Fan_Speed_Setpoint_2;
    TBlock_Input_Connector object_f32_Fan_Speed_Setpoint_3;
 
    //--------------------------------------------------------------------------
    // Function block output signals
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_f32_Fan_Supply_Voltage;
 
    TBlock_Output_Connector object_f32_Fan_Speed_1;
    TBlock_Output_Connector object_f32_Fan_Speed_2;
    TBlock_Output_Connector object_f32_Fan_Speed_3;
 
  //--------------------------------------------------------------------------
  // Protected defines, mathods and variables
  //--------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, mathods and variables
  //--------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private type declarations
    //--------------------------------------------------------------------------
 
    //! @brief Structure for status register bit parsing
    typedef union
    {
      U16 u16_Status;
      struct
      {
        U16 u16_Supply_PWM_Period_Valid:1; // Bit 0
        U16 u16_Supply_PWM_Positive_Half_Period_Valid:1; // Bit 1
        U16 u16_Supply_PWM_Negative_Half_Period_Valid:1; // Bit 2
        U16 :1; // Bit 3
        U16 u16_Supply_Channel_1_Overload:1; // Bit 4
        U16 u16_Supply_Channel_2_Overload:1; // Bit 5
        U16 u16_Supply_Channel_3_Overload:1; // Bit 6
        U16 :1; // Bit 7
        U16 u16_Speed_Status_Carrier_Period_Channel_1_Valid:1; // Bit 8
        U16 u16_Speed_Status_Carrier_Period_Channel_2_Valid:1; // Bit 9
        U16 u16_Speed_Status_Carrier_Period_Channel_3_Valid:1; // Bit 10
        U16 :1; // Bit 11
        U16 :1; // Bit 12
        U16 :1; // Bit 13
        U16 :1; // Bit 14
        U16 :1; // Bit 15
      };
    } TStatus_Register;
 
    //! @brief Structure for control register bit parsing
    typedef union
    {
      U16 u16_Control;
      struct
      {
        U16 bool_Fan_Enable_1:1; // Bit 0
        U16 bool_Fan_Enable_2:1; // Bit 1
        U16 bool_Fan_Enable_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
      };
    } TControl_Register;
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    volatile TP017_66_KG3_FAN_Registers *struct_Registers;
 
    F32 f32_PWM_Maximum_Setpoint_1;
    F32 f32_PWM_Maximum_Setpoint_2;
    F32 f32_PWM_Maximum_Setpoint_3;
 
    F32 f32_Fan_Speed_PWM_Setpoint_1;
    F32 f32_Fan_Speed_PWM_Setpoint_2;
    F32 f32_Fan_Speed_PWM_Setpoint_3;
 
    F32 f32_Supply_Voltage_Period;
    F32 f32_Supply_Voltage;
 
    F32 f32_Fan_Speed_1;
    F32 f32_Fan_Speed_2;
    F32 f32_Fan_Speed_3;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------