Code Scrub for header files in MdePkg/Include/Ppi and Uefi directory.

[mirror_edk2.git] / MdePkg / Include / Ppi / SecPlatformInformation.h

diff --git a/MdePkg/Include/Ppi/SecPlatformInformation.h b/MdePkg/Include/Ppi/SecPlatformInformation.h
index ef040ec0d059f9e93bf27f29d62b84b8578be257..21783656df227a98b14bcbe9f60e6f04a6208376 100644 (file)
--- a/MdePkg/Include/Ppi/SecPlatformInformation.h
+++ b/MdePkg/Include/Ppi/SecPlatformInformation.h
@@ -1,7 +1,12 @@
 /** @file\r
   This file declares Sec Platform Information PPI.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  This service is the primary handoff state into the PEI Foundation. \r
+  The Security (SEC) component creates the early, transitory memory \r
+  environment and also encapsulates knowledge of at least the \r
+  location of the Boot Firmware Volume (BFV).\r
+\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
@@ -29,6 +34,8 @@ typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PP
 \r
 //\r
 // EFI_HEALTH_FLAGS\r
+// Contains information generated by microcode, hardware, and/or the Itanium\r
+// processor PAL code about the state of the processor upon reset.\r
 //\r
 typedef union {\r
   struct {\r
@@ -44,27 +51,6 @@ typedef union {
   UINT32     Uint32;\r
 } EFI_HEALTH_FLAGS;\r
 \r
-\r
-/**\r
-\r
-  @param BootPhase  entry r20 value.\r
-\r
-  @param UniqueId   PAL arbitration ID.\r
-\r
-  @param HealthStat Health Status\r
-\r
-  @param PALRetAddress  Return address to PAL\r
-   \r
-**/\r
-/*\r
-typedef struct {\r
-  UINTN BootPhase;\r
-  UINTN UniqueId;\r
-  UINTN HealthStat;\r
-  UINTN PALRetAddress;\r
-} IPF_HANDOFF_STATUS;\r
-*/\r
-\r
 #define NORMAL_BOOT_CALL    0x0\r
 #define RECOVERY_CHECK_CALL 0x3\r
 \r
@@ -116,9 +102,12 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Ppi Description:\r
+  This service abstracts platform-specific information. It is necessary \r
+  to convey this information to the PEI Foundation so that it can \r
+  discover where to begin dispatching PEIMs.\r
 \r
-  @param Name\r
+  @param PlatformInformation \r
+  Conveys state information out of the SEC phase into PEI.\r
 \r
 **/\r
 struct _EFI_SEC_PLATFORM_INFORMATION_PPI {\r