Add Report Status Code related PPI/Protocol from PI 1.2 specification.

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

diff --git a/MdePkg/Include/Ppi/ReportStatusCodeHandler.h b/MdePkg/Include/Ppi/ReportStatusCodeHandler.h
new file mode 100644 (file)
index 0000000..94dd162
--- /dev/null
+++ b/MdePkg/Include/Ppi/ReportStatusCodeHandler.h
@@ -0,0 +1,83 @@
+/** @file\r
+  This ppi provide registering and unregistering services to status code consumers.\r
+  \r
+  Copyright (c) 2007 - 2009, 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
+\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
+**/\r
+\r
+#ifndef __REPORT_STATUS_CODE_HANDLER_PPI_H__\r
+#define __REPORT_STATUS_CODE_HANDLER_PPI_H__\r
+\r
+#define EFI_PEI_RSC_HANDLER_PPI_GUID \\r
+  { \\r
+    0x65d394, 0x9951, 0x4144, \\r
+    0x82, 0xa3, 0xa, 0xfc, 0x85, 0x79, 0xc2, 0x51 \\r
+  }\r
+\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_RSC_HANDLER_CALLBACK)(\r
+  IN CONST  EFI_PEI_SERVICES        **PeiServices,\r
+  IN        EFI_STATUS_CODE_TYPE    Type,\r
+  IN        EFI_STATUS_CODE_VALUE   Value,\r
+  IN        UINT32                  Instance,\r
+  IN CONST  EFI_GUID                *CallerId,\r
+  IN CONST  EFI_STATUS_CODE_DATA    *Data\r
+);\r
+\r
+/**\r
+  Register the callback function for ReportStatusCode() notification.\r
+  \r
+  When this function is called the function pointer is added to an internal list and any future calls to\r
+  ReportStatusCode() will be forwarded to the Callback function.\r
+\r
+  @param[in] Callback           A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r
+                                when a call to ReportStatusCode() occurs.\r
+                        \r
+  @retval EFI_SUCCESS           Function was successfully registered.\r
+  @retval EFI_INVALID_PARAMETER The callback function was NULL.\r
+  @retval EFI_OUT_OF_RESOURCES  The internal buffer ran out of space. No more functions can be\r
+                                registered.\r
+  @retval EFI_ALREADY_STARTED   The function was already registered. It can’t be registered again.\r
+                        \r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_RSC_HANDLER_REGISTER)(\r
+  IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r
+);\r
+\r
+/**\r
+  Remove a previously registered callback function from the notification list.\r
+  \r
+  ReportStatusCode() messages will no longer be forwarded to the Callback function.\r
+  \r
+  @param[in] Callback           A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be\r
+                                unregistered.\r
+\r
+  @retval EFI_SUCCESS           The function was successfully unregistered.\r
+  @retval EFI_INVALID_PARAMETER The callback function was NULL.\r
+  @retval EFI_NOT_FOUND         The callback function was not found to be unregistered.\r
+                        \r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_RSC_HANDLER_UNREGISTER)(\r
+  IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r
+);\r
+\r
+typedef struct _EFI_PEI_RSC_HANDLER_PPI {\r
+  EFI_PEI_RSC_HANDLER_REGISTER Register;\r
+  EFI_PEI_RSC_HANDLER_UNREGISTER Unregister;\r
+} EFI_PEI_RSC_HANDLER_PPI;\r
+\r
+extern EFI_GUID gEfiPeiRscHandlerPpiGuid;\r
+\r
+#endif // __REPORT_STATUS_CODE_HANDLER_PPI_H__\r