MdePkg/Include/Protocol/Ebc.h File Reference


Data Structures

struct  _EFI_EBC_PROTOCOL

Defines

#define EFI_EBC_INTERPRETER_PROTOCOL_GUID
#define EFI_EBC_PROTOCOL_GUID   EFI_EBC_INTERPRETER_PROTOCOL_GUID

Typedefs

typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_EBC_CREATE_THUNK )(IN EFI_EBC_PROTOCOL *This, IN EFI_HANDLE ImageHandle, IN VOID *EbcEntryPoint, OUT VOID **Thunk)
typedef EFI_STATUS(EFIAPIEFI_EBC_UNLOAD_IMAGE )(IN EFI_EBC_PROTOCOL *This, IN EFI_HANDLE ImageHandle)
typedef EFI_STATUS(EFIAPIEBC_ICACHE_FLUSH )(IN EFI_PHYSICAL_ADDRESS Start, IN UINT64 Length)
typedef EFI_STATUS(EFIAPIEFI_EBC_REGISTER_ICACHE_FLUSH )(IN EFI_EBC_PROTOCOL *This, IN EBC_ICACHE_FLUSH Flush)
typedef EFI_STATUS(EFIAPIEFI_EBC_GET_VERSION )(IN EFI_EBC_PROTOCOL *This, IN OUT UINT64 *Version)

Variables

EFI_GUID gEfiEbcProtocolGuid

Detailed Description

Describes the protocol interface to the EBC interpreter.

Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define EFI_EBC_INTERPRETER_PROTOCOL_GUID

Value:

{ \
    0x13AC6DD1, 0x73D0, 0x11D4, {0xB0, 0x6B, 0x00, 0xAA, 0x00, 0xBD, 0x6D, 0xE7 } \
  }

#define EFI_EBC_PROTOCOL_GUID   EFI_EBC_INTERPRETER_PROTOCOL_GUID

Protocol Guid Name defined in spec.


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EBC_ICACHE_FLUSH)(IN EFI_PHYSICAL_ADDRESS Start, IN UINT64 Length)

This is the prototype for the Flush callback routine. A pointer to a routine of this type is passed to the EBC EFI_EBC_REGISTER_ICACHE_FLUSH protocol service.

Parameters:
Start The beginning physical address to flush from the processor's instruction cache.
Length The number of bytes to flush from the processor's instruction cache.
Return values:
EFI_SUCCESS The function completed successfully.

typedef EFI_STATUS(EFIAPI * EFI_EBC_CREATE_THUNK)(IN EFI_EBC_PROTOCOL *This, IN EFI_HANDLE ImageHandle, IN VOID *EbcEntryPoint, OUT VOID **Thunk)

Creates a thunk for an EBC entry point, returning the address of the thunk.

A PE32+ EBC image, like any other PE32+ image, contains an optional header that specifies the entry point for image execution. However, for EBC images, this is the entry point of EBC instructions, so is not directly executable by the native processor. Therefore, when an EBC image is loaded, the loader must call this service to get a pointer to native code (thunk) that can be executed, which will invoke the interpreter to begin execution at the original EBC entry point.

Parameters:
This A pointer to the EFI_EBC_PROTOCOL instance.
ImageHandle Handle of image for which the thunk is being created.
EbcEntryPoint Address of the actual EBC entry point or protocol service the thunk should call.
Thunk Returned pointer to a thunk created.
Return values:
EFI_SUCCESS The function completed successfully.
EFI_INVALID_PARAMETER Image entry point is not 2-byte aligned.
EFI_OUT_OF_RESOURCES Memory could not be allocated for the thunk.

typedef EFI_STATUS(EFIAPI * EFI_EBC_GET_VERSION)(IN EFI_EBC_PROTOCOL *This, IN OUT UINT64 *Version)

Called to get the version of the interpreter.

This function is called to get the version of the loaded EBC interpreter. The value and format of the returned version is identical to that returned by the EBC BREAK 1 instruction.

Parameters:
This A pointer to the EFI_EBC_PROTOCOL instance.
Version Pointer to where to store the returned version of the interpreter.
Return values:
EFI_SUCCESS The function completed successfully.
EFI_INVALID_PARAMETER Version pointer is NULL.

Define for forward reference.

Registers a callback function that the EBC interpreter calls to flush the processor instruction cache following creation of thunks.

Parameters:
This A pointer to the EFI_EBC_PROTOCOL instance.
Flush Pointer to a function of type EBC_ICACH_FLUSH.
Return values:
EFI_SUCCESS The function completed successfully.

typedef EFI_STATUS(EFIAPI * EFI_EBC_UNLOAD_IMAGE)(IN EFI_EBC_PROTOCOL *This, IN EFI_HANDLE ImageHandle)

Called prior to unloading an EBC image from memory.

This function is called after an EBC image has exited, but before the image is actually unloaded. It is intended to provide the interpreter with the opportunity to perform any cleanup that may be necessary as a result of loading and executing the image.

Parameters:
This A pointer to the EFI_EBC_PROTOCOL instance.
ImageHandle Image handle of the EBC image that is being unloaded from memory.
Return values:
EFI_SUCCESS The function completed successfully.
EFI_INVALID_PARAMETER Image handle is not recognized as belonging to an EBC image that has been executed.


Variable Documentation


Generated on Thu Sep 24 23:14:19 2015 for MdePkg[ALL] by  doxygen 1.5.7.1