P015_09_V1_0_DC_Bus.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P015_09_V1_0_DC_Bus.h
//! @brief      Control board P015.09 CB  d.c. bus 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_DC_Bus.h $
//!             $Revision: 2881 $
//!             $Date: 2021-11-04 17:20:08 +0500 (Do, 04 Nov 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief DC bus board P015.05 V1.0 class
class TP015_09_V1_0_DC_Bus : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    // Register structure for generic access
    typedef struct
    {
 
      union
      {
        U16 u16_Status;   //!< Status register
        U16 u16_Control;  //!< Control register
      };
 
      I16 i16_Analog_Input_Data;   //!< Analog input channel 1 data register
      U16 u16_Reserve_0x02;
      U16 u16_Reserve_0x03;
      I16 i16_Analog_Input_Filtered_Data;
      U16 u16_Reserve_0x05;
      U16 u16_Reserve_0x06;
      U16 u16_Reserve_0x07;
 
    } TP015_09_V1_0_DC_Bus_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TP015_09_V1_0_DC_Bus(); //!< Constructor method
    virtual ~TP015_09_V1_0_DC_Bus(); //!< Destructor method
 
    VOID Map( TP015_09_V1_0_DC_Bus_Registers *struct_Registers_Base_Address ); //!< Hardware mapping method
    virtual VOID Init(); //!< Initialisation method
    virtual VOID Execute_Inputs(); //!< Execute inputs
    virtual VOID Execute(); //!< Execution method
    virtual VOID Execute_Outputs(); //!< Execute outputs
    virtual VOID Send_Information( TProtocol_Base *object_Protocol ); //!< Send information about functional block
 
    // Block parameters
 
    TBlock_Input_Connector object_f32_Analog_Input_Full_Scale; //!< Analog input channel fill scale value. Also used for channel total gain adjustment.
    TBlock_Input_Connector object_f32_Analog_Input_Offset; //!< Analog input channel offset
 
    // Block inputs
 
    TBlock_Input_Connector object_bool_Ballast_Control; //!< Ballast status
//    TBlock_Input_Connector object_bool_Crowbar_Control; //!< Crowbar status
 
    // Block outputs
 
    U16 u16_Analog_Input_Status; //!< Analog input status
    I16 i16_Analog_Input_Data; //!< Analog input data block output as I16
 
    TBlock_Output_Connector object_f32_Analog_Input_Data; //!< Analog input data block output connector
 
    TBlock_Output_Connector object_bool_Hardware_Error; //!< Critical hardware error flag
    TBlock_Output_Connector object_bool_Hardware_Limit_Error; //!< Hardware limit reached error flag
    TBlock_Output_Connector object_bool_Software_Limit_Error; // !< Software limit reached error flag
 
    TBlock_Output_Connector object_bool_Ballast_Error; //!< Ballast status signal
//    TBlock_Output_Connector object_bool_Crowbar_Error; //!< Crowbar status signal
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
 
    typedef union
    {
      U16 u16_Status;
      struct
      {
        U16 u16_ADC_Hardware_Fault_1:1; // Bit 0 - ADC hardware fault - Experemintal function
        U16 :1; // Bit 1 - Not used
        U16 :1; // Bit 2 - Not used
        U16 :1; // Bit 3 - Not used
        U16 :1; // Bit 4 - Not used
        U16 :1; // Bit 5 - Not used
        U16 u16_Ballast_Control_Feedback:1; // Bit 6 - Ballast control feedback
        U16 u16_Ballast_Status:1; // Bit 7 - Ballast status
        U16 u16_CMP_P_1_Status:1; // Bit 8 - Analog comparator P1 status
        U16 u16_CMP_P_2_Status:1; // Bit 9 - Analog comparator P2 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 :1; // Bit 15 - Not used
      };
    } TStatus;
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    volatile TP015_09_V1_0_DC_Bus_Registers *struct_Registers; //!< Pointer to register in FPGA
    U16 u16_Status;
    U16 u16_Control;
 
    F32 f32_Gain; //!< Effective gain of the voltage measurement channel
    F32 f32_Offset; //!< Effective offset of the voltage measurement channel
 
};
 
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief DC bus board P015.05 T2 V1.0 class
class TP015_09_V1_0_DC_Bus_T2 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    // 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 : Control and status register
      union
      {
 
        //! @brief 0x02 : Status register
        U16 u16_Status;
 
        //! @brief 0x02 : Control register
        U16 u16_Control;
 
      };
 
      //! @brief 0x03 : Analog input channel 1 data register
      I16 i16_Analog_Input_Data;
      
      //! @brief 0x04 : Reserved
//      U16 u16_Reserve_0x04;
      
      //! @brief 0x05 : Reserved
//      U16 u16_Reserve_0x05;
      
      //! @brief 0x06 : Analog input filtred channel 1 data register
//      I16 i16_Analog_Input_Filtered_Data;
 
    } TP015_09_V1_0_DC_Bus_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TP015_09_V1_0_DC_Bus_T2(); //!< Constructor method
    virtual ~TP015_09_V1_0_DC_Bus_T2(); //!< Destructor method
 
    VOID Map( TP015_09_V1_0_DC_Bus_Registers *struct_Registers_Base_Address ); //!< Hardware mapping method
    virtual VOID Init(); //!< Initialisation method
    virtual VOID Execute(); //!< Execution method
    virtual VOID Send_Information( TProtocol_Base *object_Protocol ); //!< Send information about functional block
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_bool_Ballast_Control; //!< Ballast status
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //! @brief Analog input data block output connector
    TBlock_Output_Connector object_f32_Analog_Input_Data; 
    
    //! @brief Comparator P1 status signal
    TBlock_Output_Connector object_bool_Comparator_P1_Status; 
    
    //! @brief Comparator P2 status signal
    TBlock_Output_Connector object_bool_Comparator_P2_Status; 
 
    //! @brief Ballast status signal
    TBlock_Output_Connector object_bool_Ballast_Status; 
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
 
    typedef union
    {
      U16 u16_Raw_Data;
      struct
      {
        U16 bit1_ADC_Hardware_Fault_1:1; // Bit 0 - ADC hardware fault - Experemintal function
        U16 :1; // Bit 1 - Not used
        U16 :1; // Bit 2 - Not used
        U16 :1; // Bit 3 - Not used
        U16 :1; // Bit 4 - Not used
        U16 :1; // Bit 5 - Not used
        U16 :1; // Bit 6 - Not used
        U16 bit1_Ballast_Status:1; // Bit 7 - Ballast status
        U16 bit1_CMP_P_1_Status:1; // Bit 8 - Analog comparator P1 status
        U16 bit1_CMP_P_2_Status:1; // Bit 9 - Analog comparator P2 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 :1; // Bit 15 - Not used
      };
    } TStatus_Register;
 
    typedef union
    {
      U16 u16_Raw_Data;
      struct
      {
        U16 :1; // Bit 0 - Not used
        U16 :1; // Bit 1 - Not used
        U16 :1; // Bit 2 - Not used
        U16 :1; // Bit 3 - Not used
        U16 :1; // Bit 4 - Not used
        U16 :1; // Bit 5 - Not used
        U16 bit1_Ballast_Control:1; // Bit 6 - Ballast control
        U16 :1; // Bit 7 - Not used
        U16 :1; // Bit 8 - Not used
        U16 :1; // Bit 9 - Not used
        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 :1; // Bit 15 - Not used
      };
    } TControl_Register;
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Pointer to register in FPGA
    volatile TP015_09_V1_0_DC_Bus_Registers *struct_Registers; 
 
    F32 f32_Gain; //!< Effective gain of the channels
    
    F32 f32_Value_Limit = (U32)115.002f;
    
    F32 f32_Code_Limit = (F32)32768.0f;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------