MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebugger / EdbCmdStep.c

/** @file\r
\r
Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
\r
**/\r
\r
#include "Edb.h"\r
\r
/**\r
\r
  Check whether current IP is EBC CALL instruction (NOTE: CALLEX is exclusive)\r
\r
  @param  Address   - EBC IP address.\r
\r
  @retval TRUE  - Current IP is EBC CALL instruction\r
  @retval FALSE - Current IP is not EBC CALL instruction\r
\r
**/\r
BOOLEAN\r
IsEBCCALL (\r
  IN UINTN            Address\r
  )\r
{\r
  if (GET_OPCODE(Address) != OPCODE_CALL) {\r
    return FALSE;\r
  }\r
\r
  if (GET_OPERANDS (Address) & OPERAND_M_NATIVE_CALL) {\r
    return FALSE;\r
  } else {\r
    return TRUE;\r
  }\r
}\r
\r
/**\r
\r
  Check whether current IP is EBC RET instruction.\r
\r
  @param  Address   - EBC IP address.\r
\r
  @retval TRUE  - Current IP is EBC RET instruction\r
  @retval FALSE - Current IP is not EBC RET instruction\r
\r
**/\r
BOOLEAN\r
IsEBCRET (\r
  IN UINTN            Address\r
  )\r
{\r
  if (GET_OPCODE(Address) != OPCODE_RET) {\r
    return FALSE;\r
  }\r
\r
  if (GET_OPERANDS (Address) != 0) {\r
    return FALSE;\r
  } else {\r
    return TRUE;\r
  }\r
}\r
\r
/**\r
\r
  DebuggerCommand - StepInto.\r
\r
  @param  CommandArg      - The argument for this command\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  ExceptionType   - Exception type.\r
  @param  SystemContext   - EBC system context.\r
\r
  @retval EFI_DEBUG_CONTINUE - formal return value\r
\r
**/\r
EFI_DEBUG_STATUS\r
DebuggerStepInto (\r
  IN     CHAR16                    *CommandArg,\r
  IN     EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,\r
  IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
  IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
  )\r
{\r
  SystemContext.SystemContextEbc->Flags |= VMFLAGS_STEP;\r
\r
  return EFI_DEBUG_BREAK;\r
}\r
\r
/**\r
\r
  DebuggerCommand - StepOver.\r
\r
  @param  CommandArg      - The argument for this command\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  ExceptionType   - Exception type.\r
  @param  SystemContext   - EBC system context.\r
\r
  @retval EFI_DEBUG_CONTINUE - formal return value\r
\r
**/\r
EFI_DEBUG_STATUS\r
DebuggerStepOver (\r
  IN     CHAR16                    *CommandArg,\r
  IN     EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,\r
  IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
  IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
  )\r
{\r
  if (IsEBCCALL((UINTN)SystemContext.SystemContextEbc->Ip)) {\r
    //\r
    // Check CALL (NOTE: CALLEX is exclusive)\r
    //\r
    DebuggerPrivate->FeatureFlags |= EFI_DEBUG_FLAG_EBC_STEPOVER;\r
  } else {\r
    //\r
    // Other instruction including CALLEX\r
    //\r
    SystemContext.SystemContextEbc->Flags |= VMFLAGS_STEP;\r
  }\r
\r
  return EFI_DEBUG_BREAK;\r
}\r
\r
/**\r
\r
  DebuggerCommand - StepOut.\r
\r
  @param  CommandArg      - The argument for this command\r
  @param  DebuggerPrivate - EBC Debugger private data structure\r
  @param  ExceptionType   - Exception type.\r
  @param  SystemContext   - EBC system context.\r
\r
  @retval EFI_DEBUG_CONTINUE - formal return value\r
\r
**/\r
EFI_DEBUG_STATUS\r
DebuggerStepOut (\r
  IN     CHAR16                    *CommandArg,\r
  IN     EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,\r
  IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
  IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
  )\r
{\r
  if (IsEBCRET((UINTN)SystemContext.SystemContextEbc->Ip)) {\r
    //\r
    // Check RET\r
    //\r
    SystemContext.SystemContextEbc->Flags |= VMFLAGS_STEP;\r
  } else {\r
    //\r
    // Other instruction\r
    //\r
    DebuggerPrivate->FeatureFlags |= EFI_DEBUG_FLAG_EBC_STEPOUT;\r
  }\r
\r
  return EFI_DEBUG_BREAK;\r
}\r