Fix doxygen issue:

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

diff --git a/MdePkg/Include/Ppi/SecPlatformInformation.h b/MdePkg/Include/Ppi/SecPlatformInformation.h
index bcba5dbf2af6f5d0cce9b2aac81c79257f54a66c..ef040ec0d059f9e93bf27f29d62b84b8578be257 100644 (file)
--- a/MdePkg/Include/Ppi/SecPlatformInformation.h
+++ b/MdePkg/Include/Ppi/SecPlatformInformation.h
@@ -1,7 +1,7 @@
 /** @file\r
   This file declares Sec Platform Information PPI.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2007, 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
@@ -10,11 +10,9 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  SecPlatformInformation.h\r
-\r
   @par Revision Reference:\r
-  This PPI is defined in PEI CIS.\r
-  Version 0.91.\r
+  This PPI is defined in PI.\r
+  Version 1.00.\r
 \r
 **/\r
 \r
@@ -28,18 +26,10 @@
 \r
 typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PPI;\r
 \r
-extern EFI_GUID gEfiSecPlatformInformationPpiGuid;\r
 \r
-typedef struct {\r
-  UINTN BootPhase;      // entry r20 value\r
-  UINTN UniqueId;       // PAL arbitration ID\r
-  UINTN HealthStat;     // Health Status\r
-  UINTN PALRetAddress;  // return address to PAL\r
-} IPF_HANDOFF_STATUS;\r
-\r
-///\r
-/// EFI_HEALTH_FLAGS\r
-///\r
+//\r
+// EFI_HEALTH_FLAGS\r
+//\r
 typedef union {\r
   struct {\r
     UINT32   Status                   : 2;\r
@@ -50,14 +40,61 @@ typedef union {
     UINT32   FloatingPointUnavailable : 1;\r
     UINT32   MiscFeaturesUnavailable  : 1;\r
     UINT32   Reserved2                :12;\r
-  }                     Bits;\r
-  UINT32                Uint32;\r
+  } Bits;\r
+  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
+typedef struct {\r
+  UINT8 BootPhase;\r
+  UINT8 FWStatus;\r
+  UINT16 Reserved1;\r
+  UINT32 Reserved2;\r
+\r
+  UINT16 ProcId;\r
+  UINT16 Reserved3;\r
+  UINT8  IdMask;\r
+  UINT8  EidMask;\r
+  UINT16 Reserved4;\r
+\r
+  UINT64 PalCallAddress;\r
+  UINT64 PalSpecialAddress;\r
+  UINT64 SelfTestStatus;\r
+  UINT64 SelfTestControl;\r
+  UINT64 MemoryBufferRequired;\r
+\r
+} IPF_HANDOFF_STATUS;\r
+\r
+\r
 typedef struct {\r
   EFI_HEALTH_FLAGS HealthFlags;\r
 } EFI_SEC_PLATFORM_INFORMATION_RECORD;\r
 \r
+\r
+\r
 /**\r
   This interface conveys state information out of the Security (SEC) phase into PEI.\r
 \r
@@ -71,14 +108,15 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SEC_PLATFORM_INFORMATION) (\r
-  IN EFI_PEI_SERVICES                      **PeiServices,\r
-  IN OUT UINT64                            *StructureSize,\r
-  OUT EFI_SEC_PLATFORM_INFORMATION_RECORD  *PlatformInformationRecord\r
-  );\r
+(EFIAPI *EFI_SEC_PLATFORM_INFORMATION)(\r
+  IN CONST  EFI_PEI_SERVICES                    **PeiServices,\r
+  IN OUT    UINT64                              *StructureSize,\r
+  OUT       EFI_SEC_PLATFORM_INFORMATION_RECORD *PlatformInformationRecord\r
+);\r
+\r
 \r
 /**\r
-  @par Ppi Description:\r
+  Ppi Description:\r
 \r
   @param Name\r
 \r
@@ -87,4 +125,7 @@ struct _EFI_SEC_PLATFORM_INFORMATION_PPI {
   EFI_SEC_PLATFORM_INFORMATION  PlatformInformation;\r
 };\r
 \r
+\r
+extern EFI_GUID gEfiSecPlatformInformationPpiGuid;\r
+\r
 #endif\r