Checked in the Protocols introduced in UEFI/PI.

[mirror_edk2.git] / MdePkg / Include / Protocol / StatusCode.h

diff --git a/MdePkg/Include/Protocol/StatusCode.h b/MdePkg/Include/Protocol/StatusCode.h
new file mode 100644 (file)
index 0000000..6bfaeae
--- /dev/null
+++ b/MdePkg/Include/Protocol/StatusCode.h
@@ -0,0 +1,77 @@
+/** @file\r
+  Status code Runtime Protocol as defined in the DXE CIS\r
+\r
+  The StatusCode () Tiano service is added to the EFI system table and the \r
+  EFI_STATUS_CODE_ARCH_PROTOCOL_GUID protocol is registered with a NULL \r
+  pointer.\r
+\r
+  No CRC of the EFI system table is required, as it is done in the DXE core.\r
+\r
+  This code abstracts Status Code reporting.\r
+\r
+  Copyright (c) 2006, 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
+  Module Name:  StatusCode.h\r
+\r
+  @par Revision Reference:\r
+  Version 0.91B.\r
+\r
+**/\r
+\r
+#ifndef __STATUS_CODE_RUNTIME_PROTOCOL_H__\r
+#define __STATUS_CODE_RUNTIME_PROTOCOL_H__\r
+\r
+#define EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID  \\r
+{ 0xd2b2b828, 0x826, 0x48a7,  { 0xb3, 0xdf, 0x98, 0x3c, 0x0, 0x60, 0x24, 0xf0 } }\r
+\r
+/**\r
+  Provides an interface that a software module can call to report a status code.\r
+\r
+  @param  Type             Indicates the type of status code being reported.\r
+  @param  Value            Describes the current status of a hardware or software entity.\r
+                           This included information about the class and subclass that is used to\r
+                           classify the entity as well as an operation.\r
+  @param  Instance         The enumeration of a hardware or software entity within\r
+                           the system. Valid instance numbers start with 1.\r
+  @param  CallerId         This optional parameter may be used to identify the caller.\r
+                           This parameter allows the status code driver to apply different rules to\r
+                           different callers.\r
+  @param  Data             This optional parameter may be used to pass additional data.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully\r
+  @retval EFI_DEVICE_ERROR      The function should not be completed due to a device error.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS \r
+(EFIAPI *EFI_REPORT_STATUS_CODE) (\r
+  IN EFI_STATUS_CODE_TYPE     Type,\r
+  IN EFI_STATUS_CODE_VALUE    Value,\r
+  IN UINT32                   Instance,\r
+  IN EFI_GUID                 *CallerId  OPTIONAL,\r
+  IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL\r
+  );\r
+\r
+/**\r
+  @par Protocol Description:\r
+  Provides the service required to report a status code to the platform firmware.\r
+  This protocol must be produced by a runtime DXE driver and may be consumed \r
+  only by the DXE Foundation.\r
+\r
+  @param  ReportStatusCode Emit a status code.\r
+\r
+**/\r
+typedef struct _EFI_STATUS_CODE_PROTOCOL {\r
+  EFI_REPORT_STATUS_CODE         ReportStatusCode;\r
+} EFI_STATUS_CODE_PROTOCOL;\r
+\r
+extern EFI_GUID gEfiStatusCodeRuntimeProtocolGuid;\r
+\r
+#endif\r