Moved the MdePkg to OldMdePkg so that new code in MdePkg does not break existing...

[mirror_edk2.git] / OldMdePkg / Include / Protocol / SmmStatusCode.h

diff --git a/OldMdePkg/Include/Protocol/SmmStatusCode.h b/OldMdePkg/Include/Protocol/SmmStatusCode.h
new file mode 100644 (file)
index 0000000..73f26d4
--- /dev/null
+++ b/OldMdePkg/Include/Protocol/SmmStatusCode.h
@@ -0,0 +1,80 @@
+/** @file\r
+  This file declares SMM Status code Protocol.\r
+\r
+  This code abstracts SMM 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:  SmmStatusCode.h\r
+\r
+  @par Revision Reference:\r
+  This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
+  Version 0.9.\r
+\r
+**/\r
+\r
+#ifndef _PROTOCOL_SMM_STATUS_CODE_H__\r
+#define _PROTOCOL_SMM_STATUS_CODE_H__\r
+\r
+//\r
+// Global ID for the Smm Status Code Protocol\r
+//\r
+#define EFI_SMM_STATUS_CODE_PROTOCOL_GUID \\r
+  { \\r
+    0x6afd2b77, 0x98c1, 0x4acd, {0xa6, 0xf9, 0x8a, 0x94, 0x39, 0xde, 0xf, 0xb1 } \\r
+  }\r
+\r
+typedef struct _EFI_SMM_STATUS_CODE_PROTOCOL  EFI_SMM_STATUS_CODE_PROTOCOL;\r
+\r
+/**\r
+  Service to emit the status code in SMM.\r
+\r
+  @param  This                  Pointer to EFI_SMM_STATUS_CODE_PROTOCOL instance.\r
+  @param  CodeType              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_SMM_REPORT_STATUS_CODE) (\r
+  IN EFI_SMM_STATUS_CODE_PROTOCOL *This,\r
+  IN EFI_STATUS_CODE_TYPE         CodeType,\r
+  IN EFI_STATUS_CODE_VALUE        Value,\r
+  IN UINT32                       Instance,\r
+  IN EFI_GUID                     *CallerId,\r
+  IN EFI_STATUS_CODE_DATA         *Data OPTIONAL\r
+  );\r
+\r
+/**\r
+  @par Protocol Description:\r
+  Provides status code services from SMM.\r
+\r
+  @param ReportStatusCode\r
+  Allows for the SMM agent to produce a status code output.\r
+\r
+**/\r
+struct _EFI_SMM_STATUS_CODE_PROTOCOL {\r
+  EFI_SMM_REPORT_STATUS_CODE  ReportStatusCode;\r
+};\r
+\r
+extern EFI_GUID gEfiSmmStatusCodeProtocolGuid;\r
+\r
+#endif\r