Communication_Link.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Communication_Link.h
//! @brief      Communication link base class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/Communication_Link.h $
//!             $Revision: 2849 $
//!             $Date: 2021-08-20 12:37:56 +0500 (Fr, 20 Aug 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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include system files
//------------------------------------------------------------------------------
 
#include "Communication_Data_Link.h"
#include "Execution_Profile.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Communication data link class
class TCommunication_Link : public TCommunication_Data_Link
{
 
  //----------------------------------------------------------------------------
  // 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.
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__TCommunication_Link.dt
    //--------------------------------------------------------------------------
 
    TCommunication_Link();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link___TCommunication_Link.dt
    //--------------------------------------------------------------------------
 
    ~TCommunication_Link();
 
    //!-------------------------------------------------------------------------
    //! @brief     Initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Init.dt
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Done.dt
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     PIO initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__PIO_Init.dt
    //--------------------------------------------------------------------------
 
    virtual VOID PIO_Init() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     PIO reinitialisation as GPIO method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__PIO_Done.dt
    //--------------------------------------------------------------------------
 
    virtual VOID PIO_Done() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Start operation method.
    //! @note      Starts operation of the communication link
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Start.dt
    //--------------------------------------------------------------------------
 
    VOID Start();
 
    //!-------------------------------------------------------------------------
    //! @brief     Stop operation method.
    //! @note      Stops operation of the communication link
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Stop.dt
    //--------------------------------------------------------------------------
 
    VOID Stop();
 
    //!-------------------------------------------------------------------------
    //! @brief     Interrupt enabale method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Interrupt_Enable.dt
    //--------------------------------------------------------------------------
 
    VOID Interrupt_Enable( U32 u32_Priority );
 
    //!-------------------------------------------------------------------------
    //! @brief     Interrupt disable method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Interrupt_Disable.dt
    //--------------------------------------------------------------------------
 
    VOID Interrupt_Disable();
 
    //!-------------------------------------------------------------------------
    //! @brief     Data receive and data transmitted interrupt service method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Interrupt.dt
    //--------------------------------------------------------------------------
 
    VOID Interrupt();
 
    //!-------------------------------------------------------------------------
    //! @brief     Data receive interrupt service method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__RX_Interrupt.dt
    //--------------------------------------------------------------------------
 
    VOID RX_Interrupt();
 
    //!-------------------------------------------------------------------------
    //! @brief     Data transmitted interrupt service method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__TX_Interrupt.dt
    //--------------------------------------------------------------------------
 
    VOID TX_Interrupt();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log recieved byte count
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Log_Recieved_Byte_Count.dt
    //--------------------------------------------------------------------------
 
    VOID Log_Recieved_Byte_Count();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log empty data error. No data received but interrupt was generated
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Log_Empty_Data_Error.dt
    //--------------------------------------------------------------------------
 
    VOID Log_Empty_Data_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log frame error
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Log_Frame_Error.dt
    //--------------------------------------------------------------------------
 
    VOID Log_Frame_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log buffer overrun error
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Log_Overrun_Error.dt
    //--------------------------------------------------------------------------
 
    VOID Log_Overrun_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log parity error
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Log_Parity_Error.dt
    //--------------------------------------------------------------------------
 
    VOID Log_Parity_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Log noise error
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Log_Noise_Error.dt
    //--------------------------------------------------------------------------
 
    VOID Log_Noise_Error();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get rec empty data error count
    //! @note      None
    //! @return    U64 - Empty data error count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Get_Empty_Data_Error_Count.dt
    //--------------------------------------------------------------------------
 
    U64 Get_Empty_Data_Error_Count();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get recieved byte count
    //! @note      None
    //! @return    U64 - Recieved byte count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Get_Recieved_Byte_Count.dt
    //--------------------------------------------------------------------------
 
    U64 Get_Recieved_Byte_Count();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get frame error count
    //! @note      None
    //! @return    U64 - Frame error count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Get_Frame_Error_Count.dt
    //--------------------------------------------------------------------------
 
    U64 Get_Frame_Error_Count();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get buffer overrun error count
    //! @note      None
    //! @return    U64 - Buffer overrun error count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Get_Overrun_Error_Count.dt
    //--------------------------------------------------------------------------
 
    U64 Get_Overrun_Error_Count();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get parity error count
    //! @note      None
    //! @return    U64 - Parity error count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Get_Parity_Error_Count.dt
    //--------------------------------------------------------------------------
 
    U64 Get_Parity_Error_Count();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get noise error count
    //! @note      None
    //! @return    U64 - Noise error count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Get_Noise_Error_Count.dt
    //--------------------------------------------------------------------------
 
    U64 Get_Noise_Error_Count();
 
    //!-------------------------------------------------------------------------
    //! @brief     1 ms cyclic execution method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Execute_1ms.dt
    //--------------------------------------------------------------------------
 
    virtual VOID Execute_1ms();
 
    //!-------------------------------------------------------------------------
    //! @brief     Background cyclic execution method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Execute.dt
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //!-------------------------------------------------------------------------
    //! @brief     Set transmit mode method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Set_Transmit_Mode.dt
    //--------------------------------------------------------------------------
 
    virtual VOID Set_Transmit_Mode();
 
    //!-------------------------------------------------------------------------
    //! @brief     Set receive mode method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommunication_Link__Set_Receive_Mode.dt
    //--------------------------------------------------------------------------
 
    virtual VOID Set_Receive_Mode();
 
    //! @brief Execution profile object 
    TExecution_Profile object_Execution_Profile;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
  
    //! @brief Recieved byte counter
    U64 u64_Recieved_Byte_Counter = (U64)0;
 
    //! @brief Empty data error counter
    U64 u64_Empty_Data_Error_Counter = (U64)0;
 
    //! @brief Frame error counter
    U64 u64_Frame_Error_Counter = (U64)0;
 
    //! @brief Buffer overrun error counter
    U64 u64_Overrun_Error_Counter = (U64)0;
 
    //! @brief Parity error counter
    U64 u64_Parity_Error_Counter = (U64)0;
 
    //! @brief Noise error counter
    U64 u64_Noise_Error_Counter = (U64)0;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------