KG3_DCBIO_V2.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       KG3_DCBIO_V2.h
//! @brief      DC 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/KG3_DCBIO_V2.h $
//!             $Revision: 2545 $
//!             $Date: 2021-03-25 13:28:47 +0500 (Чт, 25 мар 2021) $
//!             $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 "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief DC bus board P015.05 V1.0 class
class TKG3_DCBIO_V2 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
 
    //! @brief Register structure for generic access
    typedef struct
    {
 
      //! @brief 0x00 : Module identification register
      U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Module identification register
      U16 u16_Unit_ID_H;
 
      //! @brief 0x02 : Status register
      U16 u16_Status_Register;
 
      //! @brief 0x03 : Control register
      U16 u16_Control_Register;
 
      //! @brief 0x04 : Reserved
      U16 u16_Reserve_04;
 
      //! @brief 0x05 : Reserved
      U16 u16_Reserve_05;
 
      //! @brief 0x06 : Reserved
      U16 u16_Reserve_06;
 
      //! @brief 0x07 : Positive rail voltage sensor ID register
      U16 u16_Positive_Rail_Voltage_Sensor_ID_Register;
 
      //! @brief 0x08 : Positive rail voltage register
      U16 u16_Positive_Rail_Voltage_Register;
 
      //! @brief 0x09 : Positive rail voltage latch register address
      U16 u16_Positive_Rail_Voltage_Latch_Register;
 
      //! @brief 0x0A : Positive rail voltage general error counter register
      U16 u16_Positive_Rail_Voltage_General_Error_Counter_Register;
 
      //! @brief 0x0B : Positive rail voltage timeout error counter register
      U16 u16_Positive_Rail_Voltage_Timeout_Error_Counter_Register;
 
      //! @brief 0x0C : Positive rail voltage sync error counter register
      U16 u16_Positive_Rail_Voltage_Sync_Error_Counter_Register;
 
      //! @brief 0x0D : Positive rail voltage parity error counter register
      U16 u16_Positive_Rail_Voltage_Parity_Error_Counter_Register;
 
      //! @brief 0x0E : Negative rail voltage status register
      U16 u16_Negative_Rail_Voltage_Status_Register;
 
      //! @brief 0x0F : Negative rail voltage control register
      U16 u16_Negative_Rail_Voltage_Control_Register;
 
      //! @brief 0x10 : Reserved
      U16 u16_Reserve_10;
 
      //! @brief 0x11 : Reserved
      U16 u16_Reserve_11;
 
      //! @brief 0x12 : Reserved
      U16 u16_Reserve_12;
 
      //! @brief 0x13 : Negative rail voltage sensor id register
      U16 u16_Negative_Rail_Voltage_Sensor_ID_Register;
 
      //! @brief 0x14 : Negative rail voltage register
      U16 u16_Negative_Rail_Voltage_Register;
 
      //! @brief 0x15 : Negative rail voltage latch register address
      U16 u16_Negative_Rail_Voltage_Latch_Register;
 
      //! @brief 0x16 : Negative rail voltage general error counter register
      U16 u16_Negative_Rail_Voltage_General_Error_Counter_Register;
 
      //! @brief 0x17 : Negative rail voltage timeout error counter register
      U16 u16_Negative_Rail_Voltage_Timeout_Error_Counter_Register;
 
      //! @brief 0x18 : Negative rail voltage sync error counter register
      U16 u16_Negative_Rail_Voltage_Sync_Error_Counter_Register;
 
      //! @brief 0x19 : Negative rail voltage parity error counter register
      U16 u16_Negative_Rail_Voltage_Parity_Error_Counter_Register;
 
      //! @brief 0x1A : Digital input register
      U16 u16_Digital_Input_Register;
 
      //! @brief 0x1B : Digital Output register
      U16 u16_Digital_Output_Register;
 
    } TKG3_DCBIO_V2_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TKG3_DCBIO_V2();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TKG3_DCBIO_V2();
 
    //!-------------------------------------------------------------------------
    //! @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( TKG3_DCBIO_V2_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();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block outputs execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_Outputs();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block inputs execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_Inputs();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about driver over communication link protocol
    //! @note      This method sends information driver over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @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;
 
    //--------------------------------------------------------------------------
    // Block inputs
    //--------------------------------------------------------------------------
 
    //! @brief Ballast status
    TBlock_Input_Connector object_bool_Ballast_Control;
 
    //! @brief DC BUS offset
    TBlock_Input_Connector object_f32_DC_BUS_Offset;
 
    //! @brief DC BUS gain
    TBlock_Input_Connector object_f32_DC_BUS_GAIN;
 
    //! @brief Ballast setpoint 1
    TBlock_Input_Connector object_f32_Ballast_Setpoint_1;
 
    //! @brief Ballast setpoint 2
    TBlock_Input_Connector object_f32_Ballast_Setpoint_2;
 
    //! @brief Precharge enable
    TBlock_Input_Connector object_bool_Precharge_Enable;
 
    //! @brief Precharge enable
    TBlock_Input_Connector object_bool_Emergency_Stop;
 
    //--------------------------------------------------------------------------
    // Blocks 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;
 
    //! @brief Ballast status signal
    TBlock_Output_Connector object_bool_Ballast_Error;
 
    //! @brief DC BUS voltage
    TBlock_Output_Connector object_f32_DC_BUS_Voltage;
 
    //! @brief Precharge fault
    TBlock_Output_Connector object_bool_Precharge_Fault;
 
    //! @brief Ballast fault 1
    TBlock_Output_Connector object_bool_Ballast_Fault_1;
 
    //! @brief Ballast fault 2
    TBlock_Output_Connector object_bool_Ballast_Fault_2;
 
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    //! @brief Analog input status
    U16 u16_Analog_Input_Status;
 
    //! @brief Analog input data block output as I16
    I16 i16_Analog_Input_Data;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
 
    typedef union
    {
 
      U16 u16_Status;
 
      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 :1; // Bit 6 - Not used
        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
      };
 
    } TStatus;
 
    //! @brief Structure for bit parsing
    typedef union
    {
 
      //! @brief Raw data
      U16 u16_Channels;
 
      //! @brief Structure of the bits
      struct
      {
 
        //! @brief Bit 0, Channel 1
        U16 bool_Channel_1:1;
 
        //! @brief Bit 1, Channel 2
        U16 bool_Channel_2:1;
 
        //! @brief Bit 2, Channel 3
        U16 bool_Channel_3:1;
 
        //! @brief Bit 3, Channel 4
        U16 bool_Channel_4:1;
 
        //! @brief Bit 4, Channel 5
        U16 bool_Channel_5:1;
 
        //! @brief Bit 5, Channel 6
        U16 bool_Channel_6:1;
 
        //! @brief Bit 6, Channel 7
        U16 bool_Channel_7:1;
 
        //! @brief Bit 7, Channel 8
        U16 bool_Channel_8:1;
 
        //! @brief Bits 8..15, unused bits
        U16 :8;
 
      };
 
    } TChannels;
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Pointer to register in FPGA
    volatile TKG3_DCBIO_V2_Registers *struct_Registers;
 
    //! @brief Status register
    U16 u16_Status;
 
    //! @brief Control register
    U16 u16_Control;
 
    //! @brief Effective gain of the voltage measurement channel
    F32 f32_Gain;
 
    //! @brief Effective offset of the voltage measurement channel
    F32 f32_Offset;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------