P017_43_KG3_DCB.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P017_43_KG3_DCB.h
//! @brief      KG3 d.c. bus interface board P017.43 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_43_KG3_DCB/P017_43_KG3_DCB.h $
//!             $Revision: 2281 $
//!             $Date: 2020-12-13 00:29:35 +0500 (So, 13 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Global defines
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Global macros
//------------------------------------------------------------------------------
 
//! @brief DC bus interface board KG3 DCB1 T0 (P017.43) emulation class.
class TP017_43_KG3_DCB_T0 : public TFunctional_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP017_43_KG3_DCB_T0();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TP017_43_KG3_DCB_T0();
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block inputs cyclic processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_Inputs();
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block core cyclic processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block outputs cyclic processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_Outputs();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about functional block over given protocol.
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to the protocol object
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Block parameters
    //--------------------------------------------------------------------------
 
    //! @brief Analog input channel fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale;
 
    //! @brief Analog input channel offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset;
 
    //! @brief Analog input channel offset
    TBlock_Input_Connector object_f32_Analog_Input_Gain;
 
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Analog input data block output connector
    TBlock_Output_Connector object_f32_Analog_Input_Data;
 
    //! @brief Critical hardware error flag
    TBlock_Output_Connector object_bool_Hardware_Error;
 
    //! @brief Hardware limit reached error flag
    TBlock_Output_Connector object_bool_Hardware_Limit_Error;
 
    //! @brief Software limit reached error flag
    TBlock_Output_Connector object_bool_Software_Limit_Error;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    typedef union
    {
      U16 u16_Status; //!< Status word as 16-bit unsigned value
      struct
      {
        U16 bu16_ADC_Hardware_Fault:1; //!< Bit 0 - Invalid ADC data flag
        U16 :1; //!< Bit 1 - Not used
        U16 :1; //!< bu16_Comparator_Hardware_Fault:1; // Bit 2 -
        U16 :1; //!< Bit 3 - Not used
        U16 :1; //!< Bit 4 - Not used
        U16 :1; //!< Bit 5 - Not used
        U16 bu16_Sensor_Link_Fault:1; //!< Bit 6 - Sensor communication link fault
        U16 bu16_Sensor_Fault:1; //!< Bit 7 - Sensor hardware hault
        U16 bu16_Comparator_1_Status:1; //!< Bit 8 - Comparator status
        U16 bu16_Comparator_2_Status:1; //!< Bit 9 - Comparator status
        U16 :1; //!< Bit 10 - Not used
        U16 :1; //!< Bit 11 - Not used
        U16 :1; //!< Bit 12 - Not used
        U16 :1; //!< Bit 13 - Not used
        U16 :1; //!< Bit 14 - Not used
        U16 bu16_Bitstream_Input_Status:1; //!< Bit 15 - Actual bitstream input status
      };
    } TStatus;
 
    //!< Positive rail voltage status word
    U16 u16_Positive_Rail_Voltage_Status;
 
    //!< Positive rail voltage control word
    U16 u16_Positive_Rail_Voltage_Control;
 
    //!< Negative rail voltage status word
    U16 u16_Negative_Rail_Voltage_Status;
 
    //!< Negative rail voltage control word
    U16 u16_Negative_Rail_Voltage_Control;
 
    //!< Positive rail voltage raw ADC data
    I16 i16_Positive_Rail_Voltage_Data;
 
    //!< Negative rail voltage raw ADC data
    I16 i16_Negative_Rail_Voltage_Data;
 
    //!< Effective offset of the positive voltage measurement channel
    F32 f32_Positive_Rail_Voltage_Offset;
 
    //!< Effective gain of the positive voltage measurement channel
    F32 f32_Positive_Rail_Voltage_Gain;
 
};
 
//------------------------------------------------------------------------------
 
class TP017_43_KG3_DCB_T1 : public TFunctional_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
 
    // Register structure for generic access
    typedef struct
    {
 
      U16 u16_Unit_ID_L;                                  //!< 0x00 : Module identification
      U16 u16_Unit_ID_H;                                  //!< 0x01 : Module identification
 
      U16 u16_Positive_Rail_Voltage_Status;               //!< 0x02 : DC bus positive rail voltage status register
      U16 u16_Positive_Rail_Voltage_Control;              //!< 0x03 : DC bus positive rail voltage control register
 
      U16 u16_Reserved_0x04;                              //!< 0x04 : Reserved
      U16 u16_Reserved_0x05;                              //!< 0x05 : Reserved
      U16 u16_Reserved_0x06;                              //!< 0x06 : Reserved
 
      U16 u16_Positive_Rail_Voltage_Sensor_ID;            //!< 0x07 : External sensor ID
      I16 i16_Positive_Rail_Voltage_Data;                 //!< 0x08 : DC bus positive rail voltage data register as I16 value
      I16 i16_Positive_Rail_Voltage_Latch_Data;           //!< 0x09 : DC bus positive rail voltage latched data register as I16 value
 
      U16 u16_Positive_Rail_Voltage_General_Error_Count;  //!< 0x0A : Positive voltage rail general error count
      U16 u16_Positive_Rail_Voltage_Timeout_Error_Count;  //!< 0x0B : Positive voltage rail timeout error count
      U16 u16_Positive_Rail_Voltage_Sync_Error_Count;     //!< 0x0C : Positive voltage rail sync error count
      U16 u16_Positive_Rail_Voltage_Parity_Error_Count;   //!< 0x0D : Positive voltage rail parity error count
 
      U16 u16_Negative_Rail_Voltage_Status;               //!< 0x0E : DC bus negative rail voltage status register
      U16 u16_Negative_Rail_Voltage_Control;              //!< 0x0F : DC bus negative rail voltage control register
 
      U16 u16_Reserved_0x10;                              //!< 0x10 : Reserved
      U16 u16_Reserved_0x11;                              //!< 0x11 : Reserved
      U16 u16_Reserved_0x12;                              //!< 0x12 : Reserved
 
      U16 u16_Negative_Rail_Voltage_Sensor_ID;            //!< 0x13 : External sensor ID
      I16 i16_Negative_Rail_Voltage_Data;                 //!< 0x14 : DC bus negative rail voltage data register as I16 value
      I16 i16_Negative_Rail_Voltage_Latch_Data;           //!< 0x15 : DC bus negative rail voltage latched data register as I16 value
 
      U16 u16_Negative_Rail_Voltage_General_Error_Count;  //!< 0x16 : Negative voltage rail general error count
      U16 u16_Negative_Rail_Voltage_Timeout_Error_Count;  //!< 0x17 : Negative voltage rail timeout error count
      U16 u16_Negative_Rail_Voltage_Sync_Error_Count;     //!< 0x18 : Negative voltage rail sync error count
      U16 u16_Negative_Rail_Voltage_Parity_Error_Count;   //!< 0x19 : Negative voltage rail parity error count
 
    } TP017_43_KG3_DCB_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP017_43_KG3_DCB_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TP017_43_KG3_DCB_T1();
 
    //!-------------------------------------------------------------------------
    //! @brief     Map functional block to the hardware.
    //! @note      None
    //! @param     [in] *struct_Registers_Base_Address - Pointer to the base address
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TP017_43_KG3_DCB_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 inputs cyclic processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_Inputs();
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block core cyclic processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Functional block outputs cyclic processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_Outputs();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about functional block over given protocol.
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to the protocol object
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Block parameters
    //--------------------------------------------------------------------------
 
    //!< Analog input channel fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale;
 
    //!< Analog input channel offset
    TBlock_Input_Connector object_f32_Analog_Input_Offset;
 
    //!< Analog input channel offset
    TBlock_Input_Connector object_f32_Analog_Input_Gain;
 
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Block outputs
    //--------------------------------------------------------------------------
 
    //!< Analog input data block output connector
    TBlock_Output_Connector object_f32_Analog_Input_Data;
 
    //!< Critical hardware error flag
    TBlock_Output_Connector object_bool_Hardware_Error;
 
    //!< Hardware limit reached error flag
    TBlock_Output_Connector object_bool_Hardware_Limit_Error;
 
    // !< Software limit reached error flag
    TBlock_Output_Connector object_bool_Software_Limit_Error;
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    typedef union
    {
      U16 u16_Status; //!< Status word as 16-bit unsigned value
      struct
      {
        U16 bu16_ADC_Hardware_Fault:1; //!< Bit 0 - Invalid ADC data flag
        U16 :1; //!< Bit 1 - Not used
        U16 :1; //!< bu16_Comparator_Hardware_Fault:1; // Bit 2 -
        U16 :1; //!< Bit 3 - Not used
        U16 :1; //!< Bit 4 - Not used
        U16 :1; //!< Bit 5 - Not used
        U16 bu16_Sensor_Link_Fault:1; //!< Bit 6 - Sensor communication link fault
        U16 bu16_Sensor_Fault:1; //!< Bit 7 - Sensor hardware hault
        U16 bu16_Comparator_1_Status:1; //!< Bit 8 - Comparator status
        U16 bu16_Comparator_2_Status:1; //!< Bit 9 - Comparator status
        U16 :1; //!< Bit 10 - Not used
        U16 :1; //!< Bit 11 - Not used
        U16 :1; //!< Bit 12 - Not used
        U16 :1; //!< Bit 13 - Not used
        U16 :1; //!< Bit 14 - Not used
        U16 bu16_Bitstream_Input_Status:1; //!< Bit 15 - Actual bitstream input status
      };
    } TStatus;
 
    //!< Pointer to register area in FPGA
    volatile TP017_43_KG3_DCB_Registers *struct_Registers;
 
    //!< Positive rail voltage status word
    U16 u16_Positive_Rail_Voltage_Status;
 
    //!< Positive rail voltage control word
    U16 u16_Positive_Rail_Voltage_Control;
 
    //!< Negative rail voltage status word
    U16 u16_Negative_Rail_Voltage_Status;
 
    //!< Negative rail voltage control word
    U16 u16_Negative_Rail_Voltage_Control;
 
    //!< Positive rail voltage raw ADC data
    I16 i16_Positive_Rail_Voltage_Data;
 
    //!< Negative rail voltage raw ADC data
    I16 i16_Negative_Rail_Voltage_Data;
 
    //!< Effective offset of the voltage measurement channel
    F32 f32_Positive_Rail_Voltage_Offset;
 
    //!< Effective gain of the voltage measurement channel
    F32 f32_Positive_Rail_Voltage_Gain;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------