the 1st paramter of the function prototype lost the "CONST" keyword which is not...

[mirror_edk2.git] / MdePkg / Include / Uefi / UefiSpec.h

diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index 199ee37a591b6049616c38276401f6455820f930..f523246c55603ec53a5d6be6260a7dbe51ded725 100644 (file)
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -592,8 +592,8 @@ VOID
 /**\r
   Returns the value of a variable.\r
 \r
-  @param  VariableName          A Null-terminated Unicode string that is the name of the\r
-                                vendor's variable.\r
+  @param  VariableName          A Null-terminated string that is the name of the vendor's\r
+                                variable.\r
   @param  VendorGuid            A unique identifier for the vendor.\r
   @param  Attributes            If not NULL, a pointer to the memory location to return the\r
                                 attributes bitmask for the variable.\r
@@ -628,7 +628,7 @@ EFI_STATUS
   @param  VariableNameSize      The size of the VariableName buffer.\r
   @param  VariableName          On input, supplies the last VariableName that was returned\r
                                 by GetNextVariableName(). On output, returns the Nullterminated\r
-                                Unicode string of the current variable.\r
+                                string of the current variable.\r
   @param  VendorGuid            On input, supplies the last VendorGuid that was returned by\r
                                 GetNextVariableName(). On output, returns the\r
                                 VendorGuid of the current variable.\r
@@ -841,7 +841,7 @@ EFI_STATUS
   @param  ImageHandle           Handle of image to be started.\r
   @param  ExitDataSize          Pointer to the size, in bytes, of ExitData.\r
   @param  ExitData              Pointer to a pointer to a data buffer that includes a Null-terminated\r
-                                Unicode string, optionally followed by additional binary data.\r
+                                string, optionally followed by additional binary data.\r
 \r
   @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image\r
                                 has already been initialized with StartImage\r
@@ -859,11 +859,16 @@ EFI_STATUS
 /**\r
   Terminates a loaded EFI image and returns control to boot services.\r
 \r
-  @param  ImageHandle           Handle that identifies the image.\r
+  @param  ImageHandle           Handle that identifies the image. This parameter is passed to the \r
+                                image on entry.\r
   @param  ExitStatus            The image's exit code.\r
-  @param  ExitDataSize          The size, in bytes, of ExitData.\r
-  @param  ExitData              Pointer to a data buffer that includes a Null-terminated Unicode string,\r
-                                optionally followed by additional binary data.\r
+  @param  ExitDataSize          The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.\r
+  @param  ExitData              Pointer to a data buffer that includes a Null-terminated string,\r
+                                optionally followed by additional binary data. The string is a \r
+                                description that the caller may use to further indicate the reason \r
+                                for the image's exit. ExitData is only valid if ExitStatus \r
+                                is something other than EFI_SUCCESS. The ExitData buffer \r
+                                must be allocated by calling AllocatePool().\r
 \r
   @retval EFI_SUCCESS           The image specified by ImageHandle was unloaded.\r
   @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and\r
@@ -933,7 +938,7 @@ EFI_STATUS
   @param  Timeout               The number of seconds to set the watchdog timer to.\r
   @param  WatchdogCode          The numeric code to log on a watchdog timer timeout event.\r
   @param  DataSize              The size, in bytes, of WatchdogData.\r
-  @param  WatchdogData          A data buffer that includes a Null-terminated Unicode string, optionally\r
+  @param  WatchdogData          A data buffer that includes a Null-terminated string, optionally\r
                                 followed by additional binary data.\r
 \r
   @retval EFI_SUCCESS           The timeout has been set.\r
@@ -985,7 +990,7 @@ typedef enum {
   @param  DataSize              The size, in bytes, of WatchdogData.\r
   @param  ResetData             For a ResetType of EfiResetCold, EfiResetWarm, or\r
                                 EfiResetShutdown the data buffer starts with a Null-terminated\r
-                                Unicode string, optionally followed by additional binary data.\r
+                                string, optionally followed by additional binary data.\r
 \r
 **/\r
 typedef\r
@@ -1724,7 +1729,7 @@ EFI_STATUS
 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))\r
 \r
 #define EFI_RUNTIME_SERVICES_SIGNATURE  SIGNATURE_64 ('R','U','N','T','S','E','R','V')\r
-#define EFI_RUNTIME_SERVICES_REVISION   EFI_2_10_SYSTEM_TABLE_REVISION\r
+#define EFI_RUNTIME_SERVICES_REVISION   EFI_2_30_SYSTEM_TABLE_REVISION\r
 \r
 ///\r
 /// EFI Runtime Services Table\r
@@ -1776,7 +1781,7 @@ typedef struct {
 \r
 \r
 #define EFI_BOOT_SERVICES_SIGNATURE   SIGNATURE_64 ('B','O','O','T','S','E','R','V')\r
-#define EFI_BOOT_SERVICES_REVISION    EFI_2_10_SYSTEM_TABLE_REVISION\r
+#define EFI_BOOT_SERVICES_REVISION    EFI_2_30_SYSTEM_TABLE_REVISION\r
 \r
 ///\r
 /// EFI Boot Services Table\r
@@ -1900,8 +1905,8 @@ typedef struct {
   ///\r
   EFI_TABLE_HEADER                  Hdr;\r
   ///\r
-  /// A pointer to a null terminated Unicode string that identifies\r
-  /// the vendor that produces the system firmware for the platform.\r
+  /// A pointer to a null terminated string that identifies the vendor\r
+  /// that produces the system firmware for the platform.\r
   ///\r
   CHAR16                            *FirmwareVendor;\r
   ///\r
@@ -1910,7 +1915,8 @@ typedef struct {
   ///\r
   UINT32                            FirmwareRevision;\r
   ///\r
-  /// The handle for the active console input device.\r
+  /// The handle for the active console input device. This handle must support\r
+  /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.\r
   ///\r
   EFI_HANDLE                        ConsoleInHandle;\r
   ///\r
@@ -1929,6 +1935,7 @@ typedef struct {
   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   *ConOut;\r
   ///\r
   /// The handle for the active standard error console device.\r
+  /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.\r
   ///\r
   EFI_HANDLE                        StandardErrorHandle;\r
   ///\r