Committing changes to the comments, after review with engineers.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / LegacyBios.h

diff --git a/IntelFrameworkPkg/Include/Protocol/LegacyBios.h b/IntelFrameworkPkg/Include/Protocol/LegacyBios.h
index 9eaaef985ebfd8943a8464a33686f255aab541f9..17ef9522c016f342434471ac0ce29761301c164d 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/LegacyBios.h
+++ b/IntelFrameworkPkg/Include/Protocol/LegacyBios.h
@@ -6,13 +6,10 @@
   Note: The names for EFI_IA32_REGISTER_SET elements were picked to follow\r
   well known naming conventions.\r
 \r
-  Thunk - A thunk is a transition from one processor mode to another. A Thunk\r
-  is a transition from native EFI mode to 16-bit mode. A reverse thunk\r
-  would be a transition from 16-bit mode to native EFI mode.\r
-\r
-  You most likely should not use this protocol! Find the EFI way to solve the\r
-  problem to make your code portable\r
+  Thunk is the code that switches from 32-bit protected environment into the 16-bit real-mode\r
+       environment. Reverse thunk is the code that does the opposite.\r
 \r
+ \r
   Copyright (c) 2007 - 2009, 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
@@ -1122,10 +1119,8 @@ typedef union {
   @param[in,out] Reg       Register contexted passed into (and returned) from thunk to\r
                            16-bit mode\r
 \r
-  @retval FALSE   Thunk completed, and there were no BIOS errors in the target code.\r
-                  See Regs for status.\r
-  @retval TRUE    There was a BIOS erro in the target code.\r
-\r
+  @retval TRUE                Thunk completed with no BIOS errors in the target code. See Regs for status.  \r
+  @retval FALSE                  There was a BIOS error in the target code.\r
 **/\r
 typedef\r
 BOOLEAN\r
@@ -1148,10 +1143,7 @@ BOOLEAN
   @param[in] Stack       Caller allocated stack used to pass arguments\r
   @param[in] StackSize   Size of Stack in bytes\r
 \r
-  @retval FALSE   Thunk completed, and there were no BIOS errors in the target code.\r
-                  See Regs for status.\r
-  @retval TRUE    There was a BIOS erro in the target code.\r
-\r
+  @retval FALSE                 Thunk completed with no BIOS errors in the target code.                                See Regs for status.  @retval TRUE                  There was a BIOS error in the target code.\r
 **/\r
 typedef\r
 BOOLEAN\r
@@ -1233,7 +1225,7 @@ EFI_STATUS
 \r
 /**\r
   This function attempts to traditionally boot the specified BootOption. If the EFI context has\r
-  been compromised, this function will not return. This procedure is not used for loading an EFIaware\r
+  been compromised, this function will not return. This procedure is not used for loading an EFI-aware\r
   OS off a traditional device. The following actions occur:\r
   - Get EFI SMBIOS data structures, convert them to a traditional format, and copy to\r
     Compatibility16.\r
@@ -1252,7 +1244,7 @@ EFI_STATUS
   - Invoke the Compatibility16 Table function Compatibility16Boot(). This invocation\r
     causes a thunk into the Compatibility16 code, which does an INT19.\r
   - If the Compatibility16Boot() function returns, then the boot failed in a graceful\r
-    manner—i.e., EFI code is still valid. An ungraceful boot failure causes a reset because the state\r
+    manner--meaning that the EFI code is still valid. An ungraceful boot failure causes a reset because the state\r
     of EFI code is unknown.\r
 \r
   @param[in] This             Protocol instance pointer.\r
@@ -1260,11 +1252,7 @@ EFI_STATUS
   @param[in] LoadOptionSize   Size of LoadOption in size.\r
   @param[in] LoadOption       LoadOption from BootXXXX variable\r
 \r
-  @retval EFI_DEVICE_ERROR   Failed to boot from any boot device and memory is uncorrupted.\r
-                             Note: This function normally never returns. It will either boot the\r
-                             OS or reset the system if memory has been "corrupted" by loading\r
-                             a boot sector and passing control to it.\r
-\r
+  @retval EFI_DEVICE_ERROR      Failed to boot from any boot device and memory is uncorrupted.                                Note: This function normally does not returns. It will either boot the                                OS or reset the system if memory has been "corrupted" by loading                                a boot sector and passing control to it.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -1278,7 +1266,7 @@ EFI_STATUS
 /**\r
   This function takes the Leds input parameter and sets/resets the BDA accordingly. \r
   Leds is also passed to Compatibility16 code, in case any special processing is required. \r
-  This function is normally called from EFI Setup drivers that handle userselectable\r
+  This function is normally called from EFI Setup drivers that handle user-selectable\r
   keyboard options such as boot with NUM LOCK on/off. This function does not\r
   touch the keyboard or keyboard LEDs but only the BDA.\r
 \r