EbcSimpleDebugger.h File Reference

#include <Protocol/DebugSupport.h>
#include <Protocol/EbcVmTest.h>

Go to the source code of this file.

Data Structures
struct	_EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL

Macros
#define	EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL_GUID

Typedefs
typedef struct _EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL	EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EBC_DEBUGGER_SIGNAL_EXCEPTION) (IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This, IN VM_CONTEXT *VmPtr, IN EFI_EXCEPTION_TYPE ExceptionType)
typedef VOID(EFIAPI *	EBC_DEBUGGER_DEBUG) (IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This, IN VM_CONTEXT *VmPtr)
typedef UINT32(EFIAPI *	EBC_DEBUGGER_DASM) (IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This, IN VM_CONTEXT *VmPtr, IN UINT16 *DasmString OPTIONAL, IN UINT32 DasmStringSize)
typedef EFI_STATUS(EFIAPI *	EBC_DEBUGGER_CONFIGURE) (IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This, IN UINT32 ConfigId, IN UINTN ConfigValue)

Variables
EFI_GUID	gEfiEbcSimpleDebuggerProtocolGuid

Detailed Description

EBC Simple Debugger protocol for debug EBC code.

Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file EbcSimpleDebugger.h.

Macro Definition Documentation

EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL_GUID

#define EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL_GUID

Value:

  { \
    0x2a72d11e, 0x7376, 0x40f6, { 0x9c, 0x68, 0x23, 0xfa, 0x2f, 0xe3, 0x63, 0xf1 } \
  }

Definition at line 16 of file EbcSimpleDebugger.h.

Typedef Documentation

EBC_DEBUGGER_CONFIGURE

typedef EFI_STATUS(EFIAPI * EBC_DEBUGGER_CONFIGURE) (IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This, IN UINT32 ConfigId, IN UINTN ConfigValue)

This interface allows you to configure the EBC debug support driver. For example, turn on or off saving and printing of delta VM even if called. Or to even disable the entire interface, in which case all functions become no-ops.

Parameters

[in]	This	A pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in]	ConfigId	ID to be configured.
[in]	ConfigValue	Value to be set.

Return values

EFI_UNSUPPORTED	No support for it.
EFI_SUCCESS	Configure EBC debug.

Definition at line 98 of file EbcSimpleDebugger.h.

EBC_DEBUGGER_DASM

typedef UINT32(EFIAPI * EBC_DEBUGGER_DASM) (IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This, IN VM_CONTEXT *VmPtr, IN UINT16 *DasmString OPTIONAL, IN UINT32 DasmStringSize)

Given a pointer to a new VM context, dump one or more instructions.

Parameters

[in]	This	A pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in]	VmPtr	A pointer to a VM context.
[in]	DasmString	Dump string buffer.
[in]	DasmStringSize	Dump string size.

Return values

EFI_UNSUPPORTED	No support for it.
EFI_SUCCESS	Dump one or more instructions.

Definition at line 75 of file EbcSimpleDebugger.h.

EBC_DEBUGGER_DEBUG

typedef VOID(EFIAPI * EBC_DEBUGGER_DEBUG) (IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This, IN VM_CONTEXT *VmPtr)

Given a pointer to a new VM context, debug one or more instructions.

Parameters

[in]	This	A pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in]	VmPtr	A pointer to a VM context.

Return values

EFI_UNSUPPORTED	No support for it.
EFI_SUCCESS	Debug one or more instructions.

Definition at line 56 of file EbcSimpleDebugger.h.

EBC_DEBUGGER_SIGNAL_EXCEPTION

typedef EFI_STATUS(EFIAPI * EBC_DEBUGGER_SIGNAL_EXCEPTION) (IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This, IN VM_CONTEXT *VmPtr, IN EFI_EXCEPTION_TYPE ExceptionType)

Trig Exception on EBC VM.

Parameters

[in]	This	A pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in]	VmPtr	A pointer to a VM context.
[in]	ExceptionType	Exception to be trigged.

Return values

EFI_UNSUPPORTED	No support for it.
EFI_SUCCESS	Exception is trigged.

Definition at line 38 of file EbcSimpleDebugger.h.

EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL

typedef struct _EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL

Definition at line 24 of file EbcSimpleDebugger.h.