P015_09_V1_0_Crowbar.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       P015_09_V1_0_Crowbar.h
//! @brief      Control board P015.09 CB crowbar 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_Crowbar.h $
//!             $Revision: 2549 $
//!             $Date: 2021-03-25 14:39:32 +0500 (Do, 25 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
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definition
//------------------------------------------------------------------------------
 
//! @brief Board P015.09 rotor crowbar class
class TP015_09_V1_0_Crowbar : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public definies
    //--------------------------------------------------------------------------
 
    //! @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;
      
      union
      {
 
        //! @brief 0x02 : Status register
        U16 u16_Status_Register;
 
        //! @brief 0x02 : Control register
        U16 u16_Control_Register;
 
      };
 
    } TP015_09_V1_0_Crowbar_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP015_09_V1_0_Crowbar();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP015_09_V1_0_Crowbar();
 
    //!-------------------------------------------------------------------------
    //! @brief     Hardware mapping method.
    //! @note      None
    //! @param     [in] *struct_Registers_Base_Address - Pointer to mapped memory region
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TP015_09_V1_0_Crowbar_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     Initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block inputs execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_Inputs(); // Execute inputs
 
    //!-------------------------------------------------------------------------
    //! @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     Send function block diagnostic information method.
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to communication protocol
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Function block input signals
    //--------------------------------------------------------------------------
 
    //! @brief Crowbar enable signal
    TBlock_Input_Connector object_bool_Crowbar_Control;
 
    //--------------------------------------------------------------------------
    // Function block output signals
    //--------------------------------------------------------------------------
 
    //! @brief Crowbar error signal
    TBlock_Output_Connector object_bool_Crowbar_Error;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
 
    //! @brief Crowbar control register structure
    typedef union
    {
 
      //! @brief Crowbqr control register as U16 value
      U16 u16_Control_Register;
 
      //! @brief Crowbar control register bits
      struct
      {
 
        //! @brief Bit 0 - Crowbar control
        U16 u16_Crowbar_Control:1;
 
        //! @brief Bit 1 - Not used
        U16 :1;
 
        //! @brief Bit 2 - Not used
        U16 :1;
 
        //! @brief Bit 3 - Not used
        U16 :1;
 
        //! @brief Bit 4 - Not used
        U16 :1;
 
        //! @brief Bit 5 - Not used
        U16 :1;
 
        //! @brief Bit 6 - Not used
        U16 :1;
 
        //! @brief Bit 7 - Not used
        U16 :1;
 
        //! @brief Bit 8 - Not used
        U16 :1;
 
        //! @brief Bit 9 - Not used
        U16 :1;
 
        //! @brief Bit 10 - Not used
        U16 :1;
 
        //! @brief Bit 11 - Not used
        U16 :1;
 
        //! @brief Bit 12 - Not used
        U16 :1;
 
        //! @brief Bit 13 - Not used
        U16 :1;
 
        //! @brief Bit 14 - Not used
        U16 :1;
 
        //! @brief Bit 15 - Not used
        U16 :1;
 
      };
 
    } TControl_Register;
 
    //! @brief Crowbar status register structure
    typedef union
    {
 
      //! @brief Crowbar status register as U16 value
      U16 u16_Status_Register;
 
      //! @brief Crowbar status register bits
      struct
      {
 
        //! @brief Bit 0 - Crowbar status
        U16 u16_Crowbar_Status:1;
 
        //! @brief Bit 1 - Not used
        U16 :1;
 
        //! @brief Bit 2 - Not used
        U16 :1;
 
        //! @brief Bit 3 - Not used
        U16 :1;
 
        //! @brief Bit 4 - Not used
        U16 :1;
 
        //! @brief Bit 5 - Not used
        U16 :1;
 
        //! @brief Bit 6 - Not used
        U16 :1;
 
        //! @brief Bit 7 - Not used
        U16 :1;
 
        //! @brief Bit 8 - Not used
        U16 :1;
 
        //! @brief Bit 9 - Not used
        U16 :1;
 
        //! @brief Bit 10 - Not used
        U16 :1;
 
        //! @brief Bit 11 - Not used
        U16 :1;
 
        //! @brief Bit 12 - Not used
        U16 :1;
 
        //! @brief Bit 13 - Not used
        U16 :1;
 
        //! @brief Bit 14 - Not used
        U16 :1;
 
        //! @brief Bit 15 - Not used
        U16 :1;
 
      };
 
    } TStatus_Register;
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Pointer to the mapped hardware
    volatile TP015_09_V1_0_Crowbar_Registers *struct_Registers;
 
};
 
//------------------------------------------------------------------------------
 
//! @brief Board P015.09 rotor crowbar class of type 2
class TP015_09_V1_Crowbar_T2 : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public definies
    //--------------------------------------------------------------------------
 
    //! @brief Register structure for generic access
    typedef struct
    {
 
      //! @brief 0x00 : Unit identification register
      U16 u16_Unit_ID_L;
 
      //! @brief 0x01 : Unit identification register
      U16 u16_Unit_ID_H;
 
      //! @brief Control and status registers
      union
      {
 
        //! @brief 0x02 : Status register
        U16 u16_Status_Register;
 
        //! @brief 0x02 : Control register
        U16 u16_Control_Register;
 
      };
 
    } TP015_09_V1_Crowbar_Registers;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TP015_09_V1_Crowbar_T2();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TP015_09_V1_Crowbar_T2();
 
    //!-------------------------------------------------------------------------
    //! @brief     Hardware mapping method.
    //! @note      None
    //! @param     [in] *struct_Registers_Base_Address - Pointer to mapped memory region
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Map( TP015_09_V1_Crowbar_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @brief     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     Send function block diagnostic information method.
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to communication protocol
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Function block input signals
    //--------------------------------------------------------------------------
 
    //! @brief Crowbar enable signal
    TBlock_Input_Connector object_bool_Crowbar_Control;
 
    //--------------------------------------------------------------------------
    // Function block output signals
    //--------------------------------------------------------------------------
 
    //! @brief Crowbar error signal
    TBlock_Output_Connector object_bool_Crowbar_Status;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private defines
    //--------------------------------------------------------------------------
 
    //! @brief Crowbar control register structure
    typedef union
    {
 
      //! @brief Crowbqr control register as U16 value
      U16 u16_Raw_Data;
 
      //! @brief Crowbar control register bits
      struct
      {
 
        //! @brief Bit 0 - Crowbar control
        U16 b1_Crowbar_Control:1;
 
        //! @brief Bit 1 - Not used
        U16 :1;
 
        //! @brief Bit 2 - Not used
        U16 :1;
 
        //! @brief Bit 3 - Not used
        U16 :1;
 
        //! @brief Bit 4 - Not used
        U16 :1;
 
        //! @brief Bit 5 - Not used
        U16 :1;
 
        //! @brief Bit 6 - Not used
        U16 :1;
 
        //! @brief Bit 7 - Not used
        U16 :1;
 
        //! @brief Bit 8 - Not used
        U16 :1;
 
        //! @brief Bit 9 - Not used
        U16 :1;
 
        //! @brief Bit 10 - Not used
        U16 :1;
 
        //! @brief Bit 11 - Not used
        U16 :1;
 
        //! @brief Bit 12 - Not used
        U16 :1;
 
        //! @brief Bit 13 - Not used
        U16 :1;
 
        //! @brief Bit 14 - Not used
        U16 :1;
 
        //! @brief Bit 15 - Not used
        U16 :1;
 
      };
 
    } TControl_Register;
 
    //! @brief Crowbar status register structure
    typedef union
    {
 
      //! @brief Crowbar status register as U16 value
      U16 u16_Status_Register;
 
      //! @brief Crowbar status register bits
      struct
      {
 
        //! @brief Bit 0 - Crowbar status
        U16 b1_Crowbar_Status:1;
 
        //! @brief Bit 1 - Not used
        U16 :1;
 
        //! @brief Bit 2 - Not used
        U16 :1;
 
        //! @brief Bit 3 - Not used
        U16 :1;
 
        //! @brief Bit 4 - Not used
        U16 :1;
 
        //! @brief Bit 5 - Not used
        U16 :1;
 
        //! @brief Bit 6 - Not used
        U16 :1;
 
        //! @brief Bit 7 - Not used
        U16 :1;
 
        //! @brief Bit 8 - Not used
        U16 :1;
 
        //! @brief Bit 9 - Not used
        U16 :1;
 
        //! @brief Bit 10 - Not used
        U16 :1;
 
        //! @brief Bit 11 - Not used
        U16 :1;
 
        //! @brief Bit 12 - Not used
        U16 :1;
 
        //! @brief Bit 13 - Not used
        U16 :1;
 
        //! @brief Bit 14 - Not used
        U16 :1;
 
        //! @brief Bit 15 - Not used
        U16 :1;
 
      };
 
    } TStatus_Register;
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Pointer to the mapped hardware registers
    volatile TP015_09_V1_Crowbar_Registers *struct_Registers;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------