System_COM0.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      System_COM0.h
//! @brief     Virtual communication link COM0 class header file.
//! @copyright ANVILEX LLC
//! @attention No special attention requered.
//!            $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Targets/Generic/System_COM0.h $
//!            $Revision: 2203 $
//!            $Date: 2020-11-21 14:58:09 +0500 (Sa, 21 Nov 2020) $
//!            $Author: minch $
//
// Copyright(C) 2019-2020 ANVILEX LLC
//
// 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
 
//------------------------------------------------------------------------------
// System includes
//------------------------------------------------------------------------------
 
#include "Communication_Link.h"
 
//------------------------------------------------------------------------------
// Project includes
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// forward references
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// enums
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Defines
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Define command strings
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Struct
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Externe variables
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Function prototypes
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Export variables
//------------------------------------------------------------------------------
 
//! @brief Virtual communication link COM0 class
class TCOM0 : public TCommunication_Link
{
 
  //----------------------------------------------------------------------------
  // Public methods, variables and definitions
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Virtual communication link COM0 initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init(); 
  
    //!-------------------------------------------------------------------------
    //! @brief     Virtual communication link COM0 finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done(); 
    
    //!-------------------------------------------------------------------------
    //! @brief     PIO initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID PIO_Init();
    
    //!-------------------------------------------------------------------------
    //! @brief     PIO reinitialisation as GPIO method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID PIO_Done();
 
    // Interrupt and interrupt control methods
//    VOID Interrupt_Enable( U32 u32_Priority ); //!< Interrupt enabale
//    VOID Interrupt_Disable(); //!< Interrupt disable
 
    // Interrupt management method
//    VOID Interrupt(); //!< Interrupt method
 
    //!-------------------------------------------------------------------------
    //! @brief     Virtual communication link COM0 emulation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Emulation();
  
  //----------------------------------------------------------------------------
  // Protected methods, variables and definitions
  //----------------------------------------------------------------------------
 
  protected:
 
    virtual VOID Communication_Data_Transmit( U8 u8_Transmit_Value );
 
  //----------------------------------------------------------------------------
  // Private methods, variables and definitions
  //----------------------------------------------------------------------------
 
  private:
      
    //! @brief Emulation data buffer
    U8 u8_Emulation_Data_Buffer[ 256 ]; 
    
    //! @brief Emulation data index
    U32 u32_Emulation_Data_Index; 
    
    //! @brief Emulation data size
    U32 u32_Emulation_Data_Size; 
  
};
  
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// ANVILEX: By virtual communication link COM0 no interrupt requered, but 
//          if external data source present RX and TX interrupt can be 
//          implemented and enabled.
//------------------------------------------------------------------------------
 
//extern "C" void System_COM0_RX_Interrupt_Handler( void );
//extern "C" void System_COM0_TX_Interrupt_Handler( void );
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------