Add definition on SmmStatusCodeProtocol to comply the SMMCIS spec to fix the bug...

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmStatusCode.h b/IntelFrameworkPkg/Include/Protocol/SmmStatusCode.h
new file mode 100644 (file)
index 0000000..c2b9e70
--- /dev/null
+++ b/IntelFrameworkPkg/Include/Protocol/SmmStatusCode.h
@@ -0,0 +1,83 @@
+/** @file\r
+  Provides the parent dispatch service for a given SMI source generator.\r
+  The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for\r
+  the given event types.\r
+\r
+  Copyright (c) 2008 - 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
+  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 _EFI_SMM_ICHN_DISPATCH_H_\r
+#define _EFI_SMM_ICHN_DISPATCH_H_\r
+\r
+#include <PiDxe.h>\r
+#include <Pi/PiStatusCode.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
+/**\r
+  Unregister a child SMI source dispatch function with a parent SMM driver\r
+\r
+  @param  This                  Points to this instance of the EFI_SMM_STATUS_CODE_PROTOCOL.\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 status includes information about the class and subclass \r
+                                that is used to classify the entity, as well as an operation. \r
+                                For progress codes, the operation is the current activity. For \r
+                                error codes, it is the exception. For debug codes, it is not defined \r
+                                at this time.\r
+  @param  Instance              The enumeration of a hardware or software entity within the system. \r
+                                A system may contain multiple entities that match a class/subclass pairing.                                 \r
+  @param  CallerId              This optional parameter may be used to identify the caller. This parameter \r
+                                allows the status code driver to apply different rules to different callers.\r
+  @param  Data                  This optional parameter may be used to pass additional data.\r
+ \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
+/**\r
+  The EFI_SMM_STATUS_CODE_PROTOCOL provides the basic status code services while in SMRAM.\r
+ **/\r
+struct _EFI_SMM_STATUS_CODE_PROTOCOL {\r
+   EFI_SMM_REPORT_STATUS_CODE ReportStatusCode; ///< Allows for the SMM agent to produce a status code output.\r
+};\r
+\r
+extern EFI_GUID gEfiSmmStatusCodeProtocolGuid;\r
+\r
+#endif\r