Add comments for enumeration, structure data members those are referred by UefiServic...

[mirror_edk2.git] / MdePkg / Include / Pi / PiMultiPhase.h

diff --git a/MdePkg/Include/Pi/PiMultiPhase.h b/MdePkg/Include/Pi/PiMultiPhase.h
index 5a59a6476221ec36336cf6efee5c3f1fc3d7503a..e31d986e966960af71a29ada8a0607d91552a150 100644 (file)
--- a/MdePkg/Include/Pi/PiMultiPhase.h
+++ b/MdePkg/Include/Pi/PiMultiPhase.h
@@ -1,7 +1,7 @@
 /** @file\r
   Include file matches things in PI for multiple module types.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -11,7 +11,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r
-  Version 1.0.\r
+  PI Version 1.0\r
 \r
 **/\r
 \r
@@ -30,9 +30,9 @@
 \r
 #define EFI_NOT_AVAILABLE_YET   EFIERR (32)\r
 \r
-//\r
-// Status Code Type Definition\r
-//\r
+///\r
+/// Status Code Type Definition\r
+///\r
 typedef UINT32  EFI_STATUS_CODE_TYPE;\r
 \r
 //\r
@@ -67,10 +67,11 @@ typedef UINT32  EFI_STATUS_CODE_TYPE;
 #define EFI_ERROR_UNRECOVERED         0x90000000\r
 #define EFI_ERROR_UNCONTAINED         0xa0000000\r
 \r
-//\r
-// Status Code Value Definition\r
-//\r
+///\r
+/// Status Code Value Definition\r
+///\r
 typedef UINT32 EFI_STATUS_CODE_VALUE;\r
+\r
 //\r
 // A Status Code Value is made up of the class, subclass, and\r
 // an operation.\r
@@ -78,24 +79,42 @@ typedef UINT32 EFI_STATUS_CODE_VALUE;
 #define EFI_STATUS_CODE_CLASS_MASK      0xFF000000\r
 #define EFI_STATUS_CODE_SUBCLASS_MASK   0x00FF0000\r
 #define EFI_STATUS_CODE_OPERATION_MASK  0x0000FFFF\r
-//\r
-// Definition of Status Code extended data header.\r
-// The data will follow HeaderSize bytes from the beginning of\r
-// the structure and is Size bytes long.\r
-//\r
+\r
+///\r
+/// Definition of Status Code extended data header.\r
+/// The data will follow HeaderSize bytes from the beginning of\r
+/// the structure and is Size bytes long.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// The size of the structure. This is specified to enable future expansion.\r
+  ///\r
   UINT16    HeaderSize;\r
+  ///\r
+  /// The size of the data in bytes. This does not include the size of the header structure.\r
+  ///\r
   UINT16    Size;\r
+  ///\r
+  /// The GUID defining the type of the data.\r
+  ///\r
   EFI_GUID  Type;\r
 } EFI_STATUS_CODE_DATA;\r
 \r
 \r
-//\r
-// Bit values for AuthenticationStatus\r
-//\r
+///\r
+/// Bit values for Authentication Status\r
+///\r
+/// xx00 Image was not signed.\r
+/// xxx1 Platform security policy override. Assumes same meaning as 0010 (the image was signed, the\r
+///      signature was tested, and the signature passed authentication test).\r
+/// 0010 Image was signed, the signature was tested, and the signature passed authentication test.\r
+/// 0110 Image was signed and the signature was not tested.\r
+/// 1010 Image was signed, the signature was tested, and the signature failed the authentication test.\r
+///\r
 #define EFI_AUTH_STATUS_PLATFORM_OVERRIDE   0x01\r
 #define EFI_AUTH_STATUS_IMAGE_SIGNED        0x02\r
 #define EFI_AUTH_STATUS_NOT_TESTED          0x04\r
 #define EFI_AUTH_STATUS_TEST_FAILED         0x08\r
+#define EFI_AUTH_STATUS_ALL                 0x0f\r
 \r
 #endif\r