Protocol_PLUG_Over_UART.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Protocol_PLUG_Over_UART.h
//! @brief      Dummy communication protocol over UART class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2021 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/Protocol_PLUG_Over_UART.h $
//!             $Revision: 2826 $
//!             $Date: 2021-07-28 13:46:37 +0500 (Mi, 28 Jul 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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include system files
//------------------------------------------------------------------------------
 
#include "Protocol_Base.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Dummy communication protocol over UART class implementation
class TProtocol_PLUG_Over_UART : public TProtocol_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.
    //--------------------------------------------------------------------------
 
    TProtocol_PLUG_Over_UART();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TProtocol_PLUG_Over_UART();
 
    //!-------------------------------------------------------------------------
    //! @brief     Object initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     PLUG protocol 1ms cyclic processing method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_1ms();
 
    //!-------------------------------------------------------------------------
    //! @brief     Protocol execution method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method sends actual driver information over specified communication link protocol.
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to the connunication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //!-------------------------------------------------------------------------
    //! @brief     Enter in terminal operation mode method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Enter_Terminal_Mode();
 
    //!-------------------------------------------------------------------------
    //! @brief     Enter in protocol operation mode method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Enter_Protocol_Mode();
 
    //!-------------------------------------------------------------------------
    //! @brief     Enable show system welcome message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Show_System_Welcome_Message_Enable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable show system welcome message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Show_System_Welcome_Message_Disable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Enable system ready message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Show_System_Ready_Message_Enable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Disable system ready message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Show_System_Ready_Message_Disable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return terminal operation mode status method.
    //! @note      None
    //! @return    BOOL - Protocol operatuin mode status
    //! @retval    false - Non-terminal mode selected
    //! @retval    true - Terminal mode selected
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Is_Terminal_Mode();
 
    //!-------------------------------------------------------------------------
    //! @brief     Return protocol operatuin mode status method.
    //! @note      None
    //! @return    BOOL - Protocol operatuin mode status
    //! @retval    false - Non-protocol mode selected
    //! @retval    true - Protocol mode selected
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Is_Protocol_Mode();
 
    //!-------------------------------------------------------------------------
    //! @brief     Communication data receive method
    //! @note      None
    //! @param     [in] u8_Receive_Value - Received value
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Communication_Data_Receive( U8 u8_Receive_Value );
 
    //!-------------------------------------------------------------------------
    //! @brief     Communication data receive method
    //! @note      None
    //! @param     [in] void_Receive_Data - Pointer on received data
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Communication_Data_Receive( VOID *void_Receive_Data );
 
    //!-------------------------------------------------------------------------
    //! @brief     Receiveed string processing method
    //! @note      None
    //! @param     [in] *c8_String - Pointer to the null terminated string
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention This method called from interrupt
    //--------------------------------------------------------------------------
 
    virtual VOID Receive_String( C8 *c8_String );
 
    //!-------------------------------------------------------------------------
    //! @brief     Receiveed string processing method
    //! @note      This method is not used in this object.
    //! @param     [in] *c8_String - Pointer to the null terminated string
    //! @param     [in] u32_Length - Length of the string
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention This method called from interrupt
    //--------------------------------------------------------------------------
 
    virtual VOID Receive_String( C8 *c8_String, U32 u32_Length );
 
    //!-------------------------------------------------------------------------
    //! @brief     Transmit boot welcome message method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention This method called from interrupt
    //--------------------------------------------------------------------------
 
    VOID Transmit_Boot_Welcome_Message();
 
    //!-------------------------------------------------------------------------
    //! @brief     Transmit boot ready message method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Transmit_System_Ready_Message();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------