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