P015_09_V1_0_RTD.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P015_09_V1_0_RTD.h
//! @brief      Control board P015.09 CB STM32F429 resistance to digital convarter 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/P015_09_V1_0/P015_09_V1_0_RTD.h $
//!             $Revision: 2532 $
//!             $Date: 2021-03-23 14:01:51 +0500 (Di, 23 Mrz 2021) $
//!             $Author: ggavrituhin $
//------------------------------------------------------------------------------
//
// 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief RTD P013.49 V1.0 board class
//------------------------------------------------------------------------------
 
class TP015_09_V1_0_RTD : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public type declarations
    //--------------------------------------------------------------------------
  
    //! @brief Register structure for generic access
    typedef struct
    {
      
      //! @brief 0x00 : Unit identification L read register
      U16 u16_Unit_ID_L;        
      
      //! @brief 0x01 : Unit identification H read register
      U16 u16_Unit_ID_H;
 
      //! @brief 0x02 : Status and control registers union
      union
      {
        
        //! @brief 0x02 : Status register
        U16 u16_RTD_Status;         
        
        //! @brief 0x02 : Control register
        U16 u16_RTD_Control;    
        
      };
      
      //! @brief 0x03 : RTD data register
      U16 u16_RTD_Data; 
    
    } TP015_09_V1_0_RTD_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP015_09_V1_0_RTD();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP015_09_V1_0_RTD();
 
    //!-------------------------------------------------------------------------
    //! @brief     RTD board P015.09 V1.0 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( TP015_09_V1_0_RTD_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block execution method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send detailed information about RTD block.
    //! @note      None
    //! @param     [in] object_Protocol Pointer to the communication protocol object.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Input connectors
    //--------------------------------------------------------------------------
    
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_1;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_2;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_3;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_4;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_5;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_6;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_7;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_8;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_9;
    TBlock_Input_Connector object_f32_Temperature_Gain_Channel_10;
 
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_1;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_2;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_3;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_4;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_5;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_6;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_7;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_8;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_9;
    TBlock_Input_Connector object_f32_Temperature_Offset_Channel_10;
    
    //--------------------------------------------------------------------------
    // Output connectors
    //--------------------------------------------------------------------------
    
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_1;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_2;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_3;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_4;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_5;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_6;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_7;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_8;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_9;
    TBlock_Output_Connector object_u16_RTD_Raw_Data_Channel_10;
 
    TBlock_Output_Connector object_f32_Temperature_Channel_1;
    TBlock_Output_Connector object_f32_Temperature_Channel_2;
    TBlock_Output_Connector object_f32_Temperature_Channel_3;
    TBlock_Output_Connector object_f32_Temperature_Channel_4;
    TBlock_Output_Connector object_f32_Temperature_Channel_5;
    TBlock_Output_Connector object_f32_Temperature_Channel_6;
    TBlock_Output_Connector object_f32_Temperature_Channel_7;
    TBlock_Output_Connector object_f32_Temperature_Channel_8;
    TBlock_Output_Connector object_f32_Temperature_Channel_9;
    TBlock_Output_Connector object_f32_Temperature_Channel_10;
 
    union
    {
      U32 u32_Status;
      struct
      {
        U32 bool_FPGA_Timeout_Fault_Channel_1:1;
        U32 bool_RTD_Hardware_Fault_Channel_1:1;
        U32 bool_FPGA_Timeout_Fault_Channel_2:1;
        U32 bool_RTD_Hardware_Fault_Channel_2:1;
        U32 bool_FPGA_Timeout_Fault_Channel_3:1;
        U32 bool_RTD_Hardware_Fault_Channel_3:1;
        U32 bool_FPGA_Timeout_Fault_Channel_4:1;
        U32 bool_RTD_Hardware_Fault_Channel_4:1;
        U32 bool_FPGA_Timeout_Fault_Channel_5:1;
        U32 bool_RTD_Hardware_Fault_Channel_5:1;
        U32 bool_FPGA_Timeout_Fault_Channel_6:1;
        U32 bool_RTD_Hardware_Fault_Channel_6:1;
        U32 bool_FPGA_Timeout_Fault_Channel_7:1;
        U32 bool_RTD_Hardware_Fault_Channel_7:1;
        U32 bool_FPGA_Timeout_Fault_Channel_8:1;
        U32 bool_RTD_Hardware_Fault_Channel_8:1;
        U32 bool_FPGA_Timeout_Fault_Channel_9:1;
        U32 bool_RTD_Hardware_Fault_Channel_9:1;
        U32 bool_FPGA_Timeout_Fault_Channel_10:1;
        U32 bool_RTD_Hardware_Fault_Channel_10:1;
        U32 :12;
      } u32_Status_Bits;
    };
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
 
  private:
    
    // Hardware communication related methods 
    BOOL RTD_Wait(); //!< Wait for RTD ready
    BOOL RTD_Read( U16 u16_Command, U16 *u16_Data ); //!< Read register value
    BOOL RTD_Write( U16 u16_Command, U16 u16_Data ); //!< Write register value
  
    // Channel configuration related methods
    BOOL Configure_Channel( U16 u16_Command, U16 u16_Data ); //!< RTD chip configuration method
 
    // Temperature measurement related methods
    BOOL Get_Temperature_Channel_1();
    BOOL Get_Temperature_Channel_2();
    BOOL Get_Temperature_Channel_3();
    BOOL Get_Temperature_Channel_4();
    BOOL Get_Temperature_Channel_5();
    BOOL Get_Temperature_Channel_6();
    BOOL Get_Temperature_Channel_7();
    BOOL Get_Temperature_Channel_8();
    BOOL Get_Temperature_Channel_9();
    BOOL Get_Temperature_Channel_10();
 
    // Calculation related methods 
    F32 Calculate_Resistance( U16 u16_ADC_Value ); //!< Calculate resistance from ADC value
 
    volatile TP015_09_V1_0_RTD_Registers *struct_Registers; //!< FPGA memory mapped registers
 
    // Relability statistical data
    U32 u32_RTD_Timeout_Error_Count;
    
    U32 u32_RTD_Temperature_Read_Count_1;
    U32 u32_RTD_Temperature_Read_Count_2;
    U32 u32_RTD_Temperature_Read_Count_3;
    U32 u32_RTD_Temperature_Read_Count_4;
    U32 u32_RTD_Temperature_Read_Count_5;
    U32 u32_RTD_Temperature_Read_Count_6;
    U32 u32_RTD_Temperature_Read_Count_7;
    U32 u32_RTD_Temperature_Read_Count_8;
    U32 u32_RTD_Temperature_Read_Count_9;
    U32 u32_RTD_Temperature_Read_Count_10;
 
    U32 u32_RTD_Temperature_Read_Success_Count_1;
    U32 u32_RTD_Temperature_Read_Success_Count_2;
    U32 u32_RTD_Temperature_Read_Success_Count_3;
    U32 u32_RTD_Temperature_Read_Success_Count_4;
    U32 u32_RTD_Temperature_Read_Success_Count_5;
    U32 u32_RTD_Temperature_Read_Success_Count_6;
    U32 u32_RTD_Temperature_Read_Success_Count_7;
    U32 u32_RTD_Temperature_Read_Success_Count_8;
    U32 u32_RTD_Temperature_Read_Success_Count_9;
    U32 u32_RTD_Temperature_Read_Success_Count_10;
 
    U32 u32_RTD_Hardware_Error_Count_1;
    U32 u32_RTD_Hardware_Error_Count_2;
    U32 u32_RTD_Hardware_Error_Count_3;
    U32 u32_RTD_Hardware_Error_Count_4;
    U32 u32_RTD_Hardware_Error_Count_5;
    U32 u32_RTD_Hardware_Error_Count_6;
    U32 u32_RTD_Hardware_Error_Count_7;
    U32 u32_RTD_Hardware_Error_Count_8;
    U32 u32_RTD_Hardware_Error_Count_9;
    U32 u32_RTD_Hardware_Error_Count_10;
    
    U16 u16_RTD_Status_1;
    U16 u16_RTD_Status_2;
    U16 u16_RTD_Status_3;
    U16 u16_RTD_Status_4;
    U16 u16_RTD_Status_5;
    U16 u16_RTD_Status_6;
    U16 u16_RTD_Status_7;
    U16 u16_RTD_Status_8;
    U16 u16_RTD_Status_9;
    U16 u16_RTD_Status_10;
 
    F32 f32_RTD_Temperature_1;
    F32 f32_RTD_Temperature_2;
    F32 f32_RTD_Temperature_3;
    F32 f32_RTD_Temperature_4;
    F32 f32_RTD_Temperature_5;
    F32 f32_RTD_Temperature_6;
    F32 f32_RTD_Temperature_7;
    F32 f32_RTD_Temperature_8;
    F32 f32_RTD_Temperature_9;
    F32 f32_RTD_Temperature_10;
  
    volatile U32 u32_Dummy_Counter; //! ANVILEX: To remove
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------