MdePkg: Add UEFI2.5 Ramdisk device path definition

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

diff --git a/MdePkg/Include/Protocol/Ebc.h b/MdePkg/Include/Protocol/Ebc.h
index 9229590e77875a8469ce09bfedc17457706aa434..969bb5496b050a797fde37baef7a2e8b47871238 100644 (file)
--- a/MdePkg/Include/Protocol/Ebc.h
+++ b/MdePkg/Include/Protocol/Ebc.h
@@ -1,8 +1,8 @@
 /** @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
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
@@ -34,9 +34,9 @@ typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL;
   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
+  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
@@ -96,9 +96,8 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  This routine is called by the core firmware to provide the EBC driver with\r
-  a function to call to flush the CPU's instruction cache following creation\r
-  of a thunk. It is not required.\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
@@ -120,7 +119,7 @@ EFI_STATUS
   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 where to store the returned version of the interpreter.\r
+  @param  Version    Pointer to where 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
@@ -133,18 +132,12 @@ EFI_STATUS
   IN OUT UINT64                 *Version\r
   );\r
 \r
-//\r
-// Prototype for the actual EBC protocol interface\r
-//\r
-/**\r
-  This protocol provides the services that allow execution of EBC images.\r
-\r
-  @par Protocol Description:\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
+///\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