MdePkg/BaseLib: add attribute 'RETURNS_TWICE' to SetJump

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

diff --git a/MdePkg/Include/Ppi/SecPlatformInformation.h b/MdePkg/Include/Ppi/SecPlatformInformation.h
index 78d41c161d5e16d1ebb2444d2397bf2c70fbc18e..b93de9c216765452787b937d084f6144fdb79916 100644 (file)
--- a/MdePkg/Include/Ppi/SecPlatformInformation.h
+++ b/MdePkg/Include/Ppi/SecPlatformInformation.h
@@ -1,19 +1,19 @@
 /** @file\r
   This file declares Sec Platform Information PPI.\r
 \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
+  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 - 2010, 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+Copyright (c) 2006 - 2015, 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
+http://opensource.org/licenses/bsd-license.php.\r
 \r
-  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
+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
   @par Revision Reference:\r
   This PPI is introduced in PI Version 1.0.\r
@@ -23,6 +23,8 @@
 #ifndef __SEC_PLATFORM_INFORMATION_PPI_H__\r
 #define __SEC_PLATFORM_INFORMATION_PPI_H__\r
 \r
+#include <Pi/PiPeiCis.h>\r
+\r
 #define EFI_SEC_PLATFORM_INFORMATION_GUID \\r
   { \\r
     0x6f8c2b35, 0xfef4, 0x448d, {0x82, 0x56, 0xe1, 0x1b, 0x19, 0xd6, 0x10, 0x77 } \\r
@@ -53,22 +55,22 @@ typedef union {
     ///\r
     UINT32   Reserved1                :13;\r
     ///\r
-    /// A 1-bit field. If set to 1, indicates that virtual\r
+    /// A 1-bit field. If set to 1, this indicates that virtual\r
     /// memory features are not available.\r
     ///\r
     UINT32   VirtualMemoryUnavailable : 1;\r
     ///\r
-    /// A 1-bit field. If set to 1, indicates that IA-32 execution\r
+    /// A 1-bit field. If set to 1, this indicates that IA-32 execution\r
     /// is not available.\r
     ///\r
     UINT32   Ia32ExecutionUnavailable : 1;\r
     ///\r
-    /// A 1-bit field. If set to 1, indicates that the floating\r
+    /// A 1-bit field. If set to 1, this indicates that the floating\r
     /// point unit is not available.\r
     ///\r
     UINT32   FloatingPointUnavailable : 1;\r
     ///\r
-    /// A 1-bit field. If set to 1, indicates miscellaneous\r
+    /// A 1-bit field. If set to 1, this indicates miscellaneous\r
     /// functional failure other than vm, ia, or fp.\r
     /// The test status field provides additional information on\r
     /// test failures when the State field returns a value of\r
@@ -113,7 +115,7 @@ typedef struct {
   UINT8  EidMask;\r
   UINT16 Reserved4;\r
   ///\r
-  /// Address to make PAL calls\r
+  /// Address to make PAL calls.\r
   ///\r
   UINT64 PalCallAddress;\r
   ///\r
@@ -123,7 +125,7 @@ typedef struct {
   ///\r
   UINT64 PalSpecialAddress;\r
   ///\r
-  /// GR35 from PALE_EXIT state\r
+  /// GR35 from PALE_EXIT state.\r
   ///\r
   UINT64 SelfTestStatus;\r
   ///\r
@@ -134,7 +136,7 @@ typedef struct {
 } ITANIUM_HANDOFF_STATUS;\r
 \r
 ///\r
-/// EFI_SEC_PLATFORM_INFORMATION_RECORD\r
+/// EFI_SEC_PLATFORM_INFORMATION_RECORD.\r
 ///\r
 typedef union {\r
   IA32_HANDOFF_STATUS    IA32HealthFlags;\r
@@ -150,12 +152,12 @@ typedef union {
   PEI Foundation. As such, if the platform supports the built-in self test (BIST) on IA-32 Intel\r
   architecture or the PAL-A handoff state for Itanium architecture, this information is encapsulated\r
   into the data structure abstracted by this service. This information is collected for the boot-strap\r
-  processor (BSP) on IA-32, and for Itanium architecture, it is available on all processors that execute\r
+  processor (BSP) on IA-32. For Itanium architecture, it is available on all processors that execute\r
   the PEI Foundation.\r
 \r
-  @param  PeiServices               Pointer to the PEI Services Table.\r
-  @param  StructureSize             Pointer to the variable describing size of the input buffer.\r
-  @param  PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.\r
+  @param  PeiServices               The pointer to the PEI Services Table.\r
+  @param  StructureSize             The pointer to the variable describing size of the input buffer.\r
+  @param  PlatformInformationRecord The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.\r
 \r
   @retval EFI_SUCCESS               The data was successfully returned.\r
   @retval EFI_BUFFER_TOO_SMALL      The buffer was too small. The current buffer size needed to\r
@@ -172,8 +174,8 @@ EFI_STATUS
 \r
 \r
 ///\r
-/// This service abstracts platform-specific information. It is necessary \r
-/// to convey this information to the PEI Foundation so that it can \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
 struct _EFI_SEC_PLATFORM_INFORMATION_PPI {\r