MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcExecute.h

/** @file\r
  Header file for Virtual Machine support. Contains EBC defines that can\r
  be of use to a disassembler for the most part. Also provides function\r
  prototypes for VM functions.\r
\r
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _EBC_EXECUTE_H_\r
#define _EBC_EXECUTE_H_\r
\r
//\r
// Macros to check and set alignment\r
//\r
#define ASSERT_ALIGNED(addr, size)  ASSERT (!((UINT32) (addr) & (size - 1)))\r
#define IS_ALIGNED(addr, size)      !((UINT32) (addr) & (size - 1))\r
\r
//\r
// Debug macro\r
//\r
#define EBCMSG(s) gST->ConOut->OutputString (gST->ConOut, s)\r
\r
\r
/**\r
  Execute an EBC image from an entry point or from a published protocol.\r
\r
  @param  VmPtr             A pointer to a VM context.\r
\r
  @retval EFI_UNSUPPORTED   At least one of the opcodes is not supported.\r
  @retval EFI_SUCCESS       All of the instructions are executed successfully.\r
\r
**/\r
EFI_STATUS\r
EbcExecute (\r
  IN VM_CONTEXT *VmPtr\r
  );\r
\r
\r
\r
/**\r
  Returns the version of the EBC virtual machine.\r
\r
  @return The 64-bit version of EBC virtual machine.\r
\r
**/\r
UINT64\r
GetVmVersion (\r
  VOID\r
  );\r
\r
/**\r
  Writes UINTN data to memory address.\r
\r
  This routine is called by the EBC data\r
  movement instructions that write to memory. Since these writes\r
  may be to the stack, which looks like (high address on top) this,\r
\r
  [EBC entry point arguments]\r
  [VM stack]\r
  [EBC stack]\r
\r
  we need to detect all attempts to write to the EBC entry point argument\r
  stack area and adjust the address (which will initially point into the\r
  VM stack) to point into the EBC entry point arguments.\r
\r
  @param  VmPtr             A pointer to a VM context.\r
  @param  Addr              Address to write to.\r
  @param  Data              Value to write to Addr.\r
\r
  @retval EFI_SUCCESS       The instruction is executed successfully.\r
  @retval Other             Some error occurs when writing data to the address.\r
\r
**/\r
EFI_STATUS\r
VmWriteMemN (\r
  IN VM_CONTEXT   *VmPtr,\r
  IN UINTN        Addr,\r
  IN UINTN        Data\r
  );\r
\r
/**\r
  Writes 64-bit data to memory address.\r
\r
  This routine is called by the EBC data\r
  movement instructions that write to memory. Since these writes\r
  may be to the stack, which looks like (high address on top) this,\r
\r
  [EBC entry point arguments]\r
  [VM stack]\r
  [EBC stack]\r
\r
  we need to detect all attempts to write to the EBC entry point argument\r
  stack area and adjust the address (which will initially point into the\r
  VM stack) to point into the EBC entry point arguments.\r
\r
  @param  VmPtr             A pointer to a VM context.\r
  @param  Addr              Address to write to.\r
  @param  Data              Value to write to Addr.\r
\r
  @retval EFI_SUCCESS       The instruction is executed successfully.\r
  @retval Other             Some error occurs when writing data to the address.\r
\r
**/\r
EFI_STATUS\r
VmWriteMem64 (\r
  IN VM_CONTEXT   *VmPtr,\r
  IN UINTN        Addr,\r
  IN UINT64       Data\r
  );\r
\r
/**\r
  Given a pointer to a new VM context, execute one or more instructions. This\r
  function is only used for test purposes via the EBC VM test protocol.\r
\r
  @param  This              A pointer to the EFI_EBC_VM_TEST_PROTOCOL structure.\r
  @param  VmPtr             A pointer to a VM context.\r
  @param  InstructionCount  A pointer to a UINTN value holding the number of\r
                            instructions to execute. If it holds value of 0,\r
                            then the instruction to be executed is 1.\r
\r
  @retval EFI_UNSUPPORTED   At least one of the opcodes is not supported.\r
  @retval EFI_SUCCESS       All of the instructions are executed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EbcExecuteInstructions (\r
  IN EFI_EBC_VM_TEST_PROTOCOL *This,\r
  IN VM_CONTEXT               *VmPtr,\r
  IN OUT UINTN                *InstructionCount\r
  );\r
\r
#endif // ifndef _EBC_EXECUTE_H_\r