AVM2020.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       AVM2020.h
//! @brief      Anvilex vertual machine 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/Virtual_Machine/AVM2020.h $
//!             $Revision: 2264 $
//!             $Date: 2020-12-05 09:59:27 +0500 (Сб, 05 дек 2020) $
//!             $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
 
//------------------------------------------------------------------------------
// System includes
//------------------------------------------------------------------------------
 
#include "System_Resource.h"
#include "AVM_Defines.h"
 
//------------------------------------------------------------------------------
 
#define MAX_STACK_INDEX 256
 
//------------------------------------------------------------------------------
// Class declaration
//------------------------------------------------------------------------------
 
//! @brief Anvilex vertual machine class
//! @details None
class AVM2020
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      The method create application object.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    AVM2020();
 
    //!-------------------------------------------------------------------------
    //! @brief     Application destructor method
    //! @note      The method destroys application object.
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~AVM2020();
 
    //!-------------------------------------------------------------------------
    //! @brief     Application initialisation method
    //! @note      The method initialise hardware and system objects.
    //! @return    None
    //! \par       Override
    //!            Allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Vertual machine cyclic execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Vertual machine cyclic assign input method.
    //! @note      None
    //! @param     [in] *struct_Input_Memory - Pointer to input memory array
    //! @param     [in] u32_Size - Size of input memory array
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    VOID Assign_Inputs( TConOpSys_Variant_Data *struct_Input_Memory, U32 u32_Size );
    
    //!-------------------------------------------------------------------------
    //! @brief     Vertual machine cyclic assign output method.
    //! @note      None
    //! @param     [in] *struct_Output_Memory - Pointer to output memory array
    //! @param     [in] u32_Size - Size of output memory array
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    VOID Assign_Outputs( TConOpSys_Variant_Data *struct_Output_Memory, U32 u32_Size );
    
    //!-------------------------------------------------------------------------
    //! @brief     Vertual machine cyclic assign data memory method.
    //! @note      None
    //! @param     [in] *struct_Data_Memory - Pointer to data memory array
    //! @param     [in] u32_Size - Size of data memory array
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    VOID Assign_Data_Memory( TConOpSys_Variant_Data *struct_Data_Memory, U32 u32_Size );
    
    //!-------------------------------------------------------------------------
    //! @brief     Vertual machine cyclic assign program memory method.
    //! @note      None
    //! @param     [in] *struct_Program_Memory - Pointer to program memory array
    //! @param     [in] u32_Size - Size of program memory array
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    VOID Assign_Program_Memory( TConOpSys_Variant_Data *struct_Program_Memory, U32 u32_Size );
    
    //!-------------------------------------------------------------------------
    //! @brief     Vertual machine cyclic assign parameters method.
    //! @note      None
    //! @param     [in] *struct_Input_Memory - Pointer to parameter memory array
    //! @param     [in] u32_Size - Size of parameter memory array
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
    
    VOID Assign_Parameter( TConOpSys_Variant_Data *struct_Parameter_Memory, U32 u32_Size );
 
    VOID Load_Operand_1();
 
    VOID Load_Operand_2();
 
    VOID Store_Result();
 
    VOID Execute_MUL_F32();
 
    VOID Execute_DIV_F32();
 
    VOID Execute_ADD_F32();
 
    VOID Execute_SUB_F32();
 
    VOID Execute_JL_F32();
 
    VOID Execute_JG_F32();
 
    VOID Execute_JLE_F32();
 
    VOID Execute_JGE_F32();
 
    VOID Execute_EQUL_F32();
 
    VOID Execute_NOT_EQUL_F32();
 
    VOID Execute_COPY_F32();
 
    VOID Execute_GO_TO();
 
    VOID Execute_IF_GO_TO();
 
    VOID Execute_HALT();
 
    VOID Execute_CALL();
 
    VOID Execute_RET();
 
    //!-------------------------------------------------------------------------
    //! @brief     Application finalisation method
    //! @note      The method prepare hardware and system objects for the system shutdown.
    //! @return    None
    //! \par       Override
    //!            Allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    VOID Done();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Program counter 
    U32 u32_Program_Counter;
 
    //! @brief Programm counter immediate data offset
    U32 u32_Program_Counter_Offset;
 
    //! @brief Stack pointer
    U32 u32_Stack_Pointer;
 
    //! @brief Operand 1 value
    TConOpSys_Variant_Data *struct_Operand_1_Value = (TConOpSys_Variant_Data*)NULL;
 
    //! @brief Operand 2 value
    TConOpSys_Variant_Data *struct_Operand_2_Value = (TConOpSys_Variant_Data*)NULL;
 
    //! @brief Result value
    TConOpSys_Variant_Data *struct_Result_Value = (TConOpSys_Variant_Data*)NULL;
 
    //! @brief Stack
    TConOpSys_Variant_Data struct_Stack[ MAX_STACK_INDEX ];    
 
    //! @brief Pointer to the input memory
    TConOpSys_Variant_Data *Input = (TConOpSys_Variant_Data*)NULL;
 
    //! @brief Pointer to the output memory
    TConOpSys_Variant_Data *Output = (TConOpSys_Variant_Data*)NULL;
 
    //! @brief Pointer to the data memory
    TConOpSys_Variant_Data *Data_Memory = (TConOpSys_Variant_Data*)NULL;
 
    //! @brief Pointer to the program code memory
    TConOpSys_Variant_Data *Program_Memory = (TConOpSys_Variant_Data*)NULL;
 
    //! @brief Pointer to the parameter data memory
    TConOpSys_Variant_Data *Parameter = (TConOpSys_Variant_Data*)NULL;
 
    //! @brief Input memory size
    U32 u32_Input_Memory_Size;
 
    //! @brief Output memory size
    U32 u32_Output_Memory_Size;
 
    //! @brief Data memory size
    U32 u32_Data_Memory_Size;
 
    //! @brief Program code memory size
    U32 u32_Program_Memory_Size;
 
    //! @brief Parameter data memory size
    U32 u32_Parameter_Memory_Size;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------