Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

[mirror_edk2.git] / MdePkg / Include / Protocol / Ebc.h

/** @file\r
  Describes the protocol interface to the EBC interpreter.\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __EFI_EBC_PROTOCOL_H__\r
#define __EFI_EBC_PROTOCOL_H__\r
\r
#define EFI_EBC_INTERPRETER_PROTOCOL_GUID \\r
  { \\r
    0x13AC6DD1, 0x73D0, 0x11D4, {0xB0, 0x6B, 0x00, 0xAA, 0x00, 0xBD, 0x6D, 0xE7 } \\r
  }\r
\r
///\r
/// Protocol Guid Name defined in spec.\r
///\r
#define EFI_EBC_PROTOCOL_GUID EFI_EBC_INTERPRETER_PROTOCOL_GUID\r
\r
///\r
/// Define for forward reference.\r
///\r
typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL;\r
\r
/**\r
  Creates a thunk for an EBC entry point, returning the address of the thunk.\r
  \r
  A PE32+ EBC image, like any other PE32+ image, contains an optional header that specifies the\r
  entry point for image execution. However, for EBC images, this is the entry point of EBC\r
  instructions, so is not directly executable by the native processor. Therefore, when an EBC image is\r
  loaded, the loader must call this service to get a pointer to native code (thunk) that can be executed,\r
  which will invoke the interpreter to begin execution at the original EBC entry point.\r
\r
  @param  This          A pointer to the EFI_EBC_PROTOCOL instance.\r
  @param  ImageHandle   Handle of image for which the thunk is being created.\r
  @param  EbcEntryPoint Address of the actual EBC entry point or protocol service the thunk should call.\r
  @param  Thunk         Returned pointer to a created thunk.\r
\r
  @retval EFI_SUCCESS            The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER  Image entry point is not 2-byte aligned.\r
  @retval EFI_OUT_OF_RESOURCES   Memory could not be allocated for the thunk.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EBC_CREATE_THUNK)(\r
  IN EFI_EBC_PROTOCOL           *This,\r
  IN EFI_HANDLE                 ImageHandle,\r
  IN VOID                       *EbcEntryPoint,\r
  OUT VOID                      **Thunk\r
  );\r
\r
/**\r
  Called prior to unloading an EBC image from memory.\r
\r
  This function is called after an EBC image has exited, but before the image is actually unloaded. It\r
  is intended to provide the interpreter with the opportunity to perform any cleanup that may be\r
  necessary as a result of loading and executing the image.\r
\r
  @param  This          A pointer to the EFI_EBC_PROTOCOL instance.\r
  @param  ImageHandle   Image handle of the EBC image that is being unloaded from memory.\r
\r
  @retval EFI_SUCCESS            The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER  Image handle is not recognized as belonging \r
                                 to an EBC image that has been executed.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EBC_UNLOAD_IMAGE)(\r
  IN EFI_EBC_PROTOCOL           *This,\r
  IN EFI_HANDLE                 ImageHandle\r
  );\r
\r
/**\r
  This is the prototype for the Flush callback routine. A pointer to a routine \r
  of this type is passed to the EBC EFI_EBC_REGISTER_ICACHE_FLUSH protocol service.\r
\r
  @param  Start  The beginning physical address to flush from the processor's instruction cache.\r
  @param  Length The number of bytes to flush from the processor's instruction cache.\r
\r
  @retval EFI_SUCCESS            The function completed successfully.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EBC_ICACHE_FLUSH)(\r
  IN EFI_PHYSICAL_ADDRESS     Start,\r
  IN UINT64                   Length\r
  );\r
\r
/**\r
  Registers a callback function that the EBC interpreter calls to flush \r
  the processor instruction cache following creation of thunks.\r
\r
  @param  This       A pointer to the EFI_EBC_PROTOCOL instance.\r
  @param  Flush      Pointer to a function of type EBC_ICACH_FLUSH.\r
\r
  @retval EFI_SUCCESS            The function completed successfully.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EBC_REGISTER_ICACHE_FLUSH)(\r
  IN EFI_EBC_PROTOCOL           *This,\r
  IN EBC_ICACHE_FLUSH           Flush\r
  );\r
\r
/**\r
  Called to get the version of the interpreter.\r
\r
  This function is called to get the version of the loaded EBC interpreter. The value and format of the\r
  returned version is identical to that returned by the EBC BREAK 1 instruction.\r
\r
  @param  This       A pointer to the EFI_EBC_PROTOCOL instance.  \r
  @param  Version 	 Pointer to the location to store the returned version of the interpreter.\r
\r
  @retval EFI_SUCCESS            The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER  Version pointer is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EBC_GET_VERSION)(\r
  IN EFI_EBC_PROTOCOL           *This,\r
  IN OUT UINT64                 *Version\r
  );\r
\r
///\r
/// The EFI EBC protocol provides services to load and execute EBC images, which will typically be\r
/// loaded into option ROMs. The image loader will load the EBC image, perform standard relocations,\r
/// and invoke the CreateThunk() service to create a thunk for the EBC image's entry point. The\r
/// image can then be run using the standard EFI start image services.\r
///\r
struct _EFI_EBC_PROTOCOL {\r
  EFI_EBC_CREATE_THUNK          CreateThunk;\r
  EFI_EBC_UNLOAD_IMAGE          UnloadImage;\r
  EFI_EBC_REGISTER_ICACHE_FLUSH RegisterICacheFlush;\r
  EFI_EBC_GET_VERSION           GetVersion;\r
};\r
\r
//\r
// Extern the global EBC protocol GUID\r
//\r
extern EFI_GUID gEfiEbcProtocolGuid;\r
\r
#endif\r