EbcSimpleDebugger.h File Reference

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 IN VM_CONTEXT *	VmPtr
typedef IN VM_CONTEXT IN EFI_EXCEPTION_TYPE	ExceptionType
typedef IN VM_CONTEXT IN UINT16 *	DasmString
typedef IN VM_CONTEXT IN UINT16 IN UINT32	DasmStringSize
typedef IN UINT32	ConfigId
typedef IN UINT32 IN UINTN	ConfigValue

Functions
typedef	EFI_STATUS (EFIAPI *EBC_DEBUGGER_SIGNAL_EXCEPTION)(IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This
typedef	VOID (EFIAPI *EBC_DEBUGGER_DEBUG)(IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This
typedef	UINT32 (EFIAPI *EBC_DEBUGGER_DASM)(IN EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *This

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

Macro Definition Documentation

#define EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL_GUID

Value:

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

Typedef Documentation

typedef IN UINT32 ConfigId

typedef IN UINT32 IN UINTN ConfigValue

typedef IN VM_CONTEXT IN UINT16* DasmString

typedef IN VM_CONTEXT IN UINT16 IN UINT32 DasmStringSize

typedef struct _EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL

typedef IN VM_CONTEXT IN EFI_EXCEPTION_TYPE ExceptionType

typedef IN VM_CONTEXT * VmPtr

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

EBC_DEBUGGER_CONFIGURE

)

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.

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.

typedef UINT32

(

EFIAPI *

EBC_DEBUGGER_DASM

)

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.

typedef VOID

(

EFIAPI *

EBC_DEBUGGER_DEBUG

)

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.

Variable Documentation

EFI_GUID gEfiEbcSimpleDebuggerProtocolGuid