Fix the comments in the core interface to follow the UEFI Spec regarding how to check...

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

diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index 2dbef696d56c88cedd13fbbb5a657e4486442f46..b6441c612a0e45036af81b5e557b421ab9cfd0f2 100644 (file)
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -1,11 +1,11 @@
 /** @file\r
   Include file that supports UEFI.\r
 \r
-  This include file must only contain things defined in the UEFI 2.1 specification.\r
-  If a code construct is defined in the UEFI 2.1 specification it must be included\r
+  This include file must contain things defined in the UEFI 2.3 specification.\r
+  If a code construct is defined in the UEFI 2.3 specification it must be included\r
   by this include file.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -23,6 +23,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include <Protocol/DevicePath.h>\r
 #include <Protocol/SimpleTextIn.h>\r
+#include <Protocol/SimpleTextInEx.h>\r
 #include <Protocol/SimpleTextOut.h>\r
 \r
 ///\r
@@ -275,7 +276,7 @@ EFI_STATUS
                                 2) No drivers were connected to ControllerHandle, but\r
                                 RemainingDevicePath is not NULL, and it is an End Device\r
                                 Path Node.\r
-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
   @retval EFI_NOT_FOUND         1) There are no EFI_DRIVER_BINDING_PROTOCOL instances\r
                                 present in the system.\r
                                 2) No drivers were connected to ControllerHandle.\r
@@ -821,7 +822,11 @@ EFI_STATUS
   @retval EFI_LOAD_ERROR        Image was not loaded because the image format was corrupt or not\r
                                 understood.\r
   @retval EFI_DEVICE_ERROR      Image was not loaded because the device returned a read error.\r
-\r
+  @retval EFI_ACCESS_DENIED     Image was not loaded because the platform policy prohibits the \r
+                                image from being loaded. NULL is returned in *ImageHandle.\r
+  @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a \r
+                                valid EFI_LOADED_IMAGE_PROTOCOL. However, the current \r
+                                platform policy specifies that the image should not be started.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -1162,7 +1167,7 @@ EFI_STATUS
   @retval EFI_ACCESS_DENIED     The protocol interface could not be reinstalled,\r
                                 because OldInterface is still being used by a\r
                                 driver that will not release it.\r
-  @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER Handle is NULL.\r
   @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
 \r
 **/\r
@@ -1188,7 +1193,7 @@ EFI_STATUS
   @retval EFI_NOT_FOUND         The interface was not found.\r
   @retval EFI_ACCESS_DENIED     The interface was not removed because the interface\r
                                 is still being used by a driver.\r
-  @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER Handle is NULL.\r
   @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
 \r
 **/\r
@@ -1228,7 +1233,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           The interface information for the specified protocol was returned.\r
   @retval EFI_UNSUPPORTED       The device does not support the specified protocol.\r
-  @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER Handle is NULL.\r
   @retval EFI_INVALID_PARAMETER Protocol is NULL.\r
   @retval EFI_INVALID_PARAMETER Interface is NULL.\r
 \r
@@ -1487,7 +1492,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           The (Guid, Table) pair was added, updated, or removed.\r
   @retval EFI_NOT_FOUND         An attempt was made to delete a nonexistent entry.\r
-  @retval EFI_INVALID_PARAMETER Guid is not valid.\r
+  @retval EFI_INVALID_PARAMETER Guid is NULL.\r
   @retval EFI_OUT_OF_RESOURCES  There is not enough memory available to complete the operation.\r
 \r
 **/\r
@@ -1719,16 +1724,17 @@ EFI_STATUS
 // EFI Runtime Services Table\r
 //\r
 #define EFI_SYSTEM_TABLE_SIGNATURE      SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')\r
+#define EFI_2_31_SYSTEM_TABLE_REVISION  ((2 << 16) | (31))\r
 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))\r
 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))\r
 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))\r
 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))\r
 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))\r
 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))\r
-#define EFI_SYSTEM_TABLE_REVISION       EFI_2_30_SYSTEM_TABLE_REVISION\r
+#define EFI_SYSTEM_TABLE_REVISION       EFI_2_31_SYSTEM_TABLE_REVISION\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_30_SYSTEM_TABLE_REVISION\r
+#define EFI_RUNTIME_SERVICES_REVISION   EFI_2_31_SYSTEM_TABLE_REVISION\r
 \r
 ///\r
 /// EFI Runtime Services Table.\r
@@ -1780,7 +1786,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_30_SYSTEM_TABLE_REVISION\r
+#define EFI_BOOT_SERVICES_REVISION    EFI_2_31_SYSTEM_TABLE_REVISION\r
 \r
 ///\r
 /// EFI Boot Services Table.\r