P005_03_V2_0_AI_V.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P005_03_V2_0_AI_V.h
//! @brief      Analog input board P005.03 V2.0 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/P005_03_V2_0_AI/P005_03_V2_0_AI_V.h $
//!             $Revision: 2280 $
//!             $Date: 2020-12-12 16:29:27 +0500 (Sa, 12 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"
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//! @brief Analog input P005.03 V2.0 board TP005_03_V2_0_AI_V class
class TP005_03_V2_0_AI_V : public TFunctional_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
 
    // Register structure for generic access
    typedef struct
    {
 
      // Analog value registers
      U16 u16_Analog_Input_Status;   //!< Status register
      I16 i16_Analog_Input_Data_1;   //!< Analog input channel 1 data register as I16 value
      I16 i16_Analog_Input_Data_2;   //!< Analog input channel 2 data register as I16 value
      I16 i16_Analog_Input_Data_3;   //!< Analog input channel 3 data register as I16 value
      U16 u16_Reserve_0x04;
      I16 i16_Analog_Input_Filtered_Data_1;
      I16 i16_Analog_Input_Filtered_Data_2;
      I16 i16_Analog_Input_Filtered_Data_3;
 
    } TP005_03_V2_0_AI_V_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP005_03_V2_0_AI_V();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TP005_03_V2_0_AI_V();
 
    VOID Map( TP005_03_V2_0_AI_V_Registers *struct_Registers_Base_Address );
    virtual VOID Init();
    virtual VOID Execute();
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Block parameter signals
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_1; //!< Analog input channel 1 fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_2; //!< Analog input channel 1 fill scale value. Also used for channel total gain gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale_3; //!< Analog input channel 1 fill scale value. Also used for channel total gain gain adjustment.
 
    TBlock_Input_Connector object_f32_Analog_Input_Offset_1; //!< Analog input channel 1 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_2; //!< Analog input channel 2 offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset_3; //!< Analog input channel 3 offset
 
    //--------------------------------------------------------------------------
    // Block input signals
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Magnitude_Software_Level;
 
    //--------------------------------------------------------------------------
    // Block output signals
    //--------------------------------------------------------------------------
 
    U16 u16_Analog_Input_Status; //!< Analog input status
    I16 i16_Analog_Input_Data_1; //!< Analog input channel 1 block output as I16
    I16 i16_Analog_Input_Data_2; //!< Analog input channel 2 block output as I16
    I16 i16_Analog_Input_Data_3; //!< Analog input channel 3 block output as I16
 
    TBlock_Output_Connector object_f32_Analog_Input_Data_1; //!< Analog input channel 1 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_2; //!< Analog input channel 2 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_3; //!< Analog input channel 3 block output
    TBlock_Output_Connector object_f32_Analog_Input_Data_DC; //!< Analog input channels DC offset
 
    TBlock_Output_Connector object_f32_AN; //!< Analog input channel 1 block output
    TBlock_Output_Connector object_f32_BN; //!< Analog input channel 2 block output
    TBlock_Output_Connector object_f32_CN; //!< Analog input channel 3 block output
 
    TBlock_Output_Connector object_bool_Hardware_Error; //!< Critical hardware error flag
    TBlock_Output_Connector object_bool_Symmenty_Error; //!< Signal symmery error flag
    TBlock_Output_Connector object_bool_Magnitude_Hardware_Level_Error; //!< Hardware limit reached error flag
    TBlock_Output_Connector object_bool_Magnitude_Software_Level_Error; // !< Software magnitude limit reached error flag
 
  //----------------------------------------------------------------------------
  // 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;
        U16 u16_ADC_Hardware_Fault_2:1;
        U16 u16_ADC_Hardware_Fault_3:1;
        U16 :1;
        U16 :1;
        U16 :1;
        U16 :1;
        U16 u16_CMP_P_1_Status:1;
        U16 u16_CMP_N_1_Status:1;
        U16 u16_CMP_P_2_Status:1;
        U16 u16_CMP_N_2_Status:1;
        U16 u16_CMP_P_3_Status:1;
        U16 u16_CMP_N_3_Status:1;
        U16 :1;
        U16 :1;
        U16 :1;
      };
    } TStatus;
 
    volatile TP005_03_V2_0_AI_V_Registers *struct_Registers; //!< Hardware mapped registers
 
    F32 f32_Gain_1; //!< Effective gain of the channel 1
    F32 f32_Gain_2; //!< Effective gain of the channel 2
    F32 f32_Gain_3; //!< Effective gain of the channel 3
 
    F32 f32_Offset_1; //!< Effective offset of the channel 1
    F32 f32_Offset_2; //!< Effective offset of the channel 2
    F32 f32_Offset_3; //!< Effective offset of the channel 3
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------