MdePkg PiPeiCis.h: Add description for notification PPI from SEC

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

diff --git a/MdePkg/Include/Pi/PiPeiCis.h b/MdePkg/Include/Pi/PiPeiCis.h
index 6e8c6d40c1d8dda4444a9515b66030635b8e67c4..eda814a8701a2001853682de970bcc72909ac0f9 100644 (file)
--- a/MdePkg/Include/Pi/PiPeiCis.h
+++ b/MdePkg/Include/Pi/PiPeiCis.h
@@ -1,7 +1,7 @@
 /** @file\r
   PI PEI master include file. This file should match the PI spec.\r
 \r
-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, 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
@@ -12,7 +12,7 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r
-  PI Version 1.4.\r
+  PI Version 1.4a.\r
 \r
 **/\r
 \r
@@ -73,6 +73,7 @@ EFI_STATUS
   @param  Ppi              Address of the PPI that was installed.\r
 \r
   @return Status of the notification.\r
+          The status code returned from this function is ignored.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -229,7 +230,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           The interface was successfully installed.\r
   @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the \r
-                                list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+                                list do not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.\r
   @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.\r
 \r
 **/\r
@@ -461,7 +462,7 @@ EFI_STATUS
   @retval EFI_OUT_OF_RESOURCES  The pages could not be allocated.\r
   @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, \r
                                 EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r
-                                EfiACPIReclaimMemory, or EfiACPIMemoryNVS.\r
+                                EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.\r
 \r
 **/\r
 typedef\r
@@ -589,7 +590,7 @@ EFI_STATUS
 \r
   @param[in] ResetType      The type of reset to perform.\r
   @param[in] ResetStatus    The status code for the reset.\r
-  @param[in] DataSize       The size, in bytes, of WatchdogData.\r
+  @param[in] DataSize       The size, in bytes, of ResetData.\r
   @param[in] ResetData      For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown\r
                             the data buffer starts with a Null-terminated string, optionally\r
                             followed by additional binary data. The string is a description\r
@@ -1003,13 +1004,14 @@ typedef struct _EFI_SEC_PEI_HAND_OFF {
   allows the SEC phase to pass information about the stack,\r
   temporary RAM and the Boot Firmware Volume. In addition, it also\r
   allows the SEC phase to pass services and data forward for use\r
-  during the PEI phase in the form of one or more PPIs. There is\r
-  no limit to the number of additional PPIs that can be passed\r
-  from SEC into the PEI Foundation. As part of its initialization\r
-  phase, the PEI Foundation will add these SEC-hosted PPIs to its\r
-  PPI database such that both the PEI Foundation and any modules\r
-  can leverage the associated service calls and/or code in these\r
-  early PPIs.\r
+  during the PEI phase in the form of one or more PPIs. These PPI's\r
+  will be installed and/or immediately signaled if they are\r
+  notification type. There is no limit to the number of additional\r
+  PPIs that can be passed from SEC into the PEI Foundation. As part\r
+  of its initialization phase, the PEI Foundation will add these\r
+  SEC-hosted PPIs to its PPI database such that both the PEI\r
+  Foundation and any modules can leverage the associated service\r
+  calls and/or code in these early PPIs.\r
 \r
   @param SecCoreData    Points to a data structure containing\r
                         information about the PEI core's\r