summaryrefslogtreecommitdiff
path: root/Core/MdePkg/Include/Protocol/SmmStatusCode.h
diff options
context:
space:
mode:
authorGuo Mang <mang.guo@intel.com>2016-12-22 15:57:14 +0800
committerGuo Mang <mang.guo@intel.com>2016-12-26 19:14:41 +0800
commit1760cf81e4b1847c6823ea3514a78dd120e19b6e (patch)
tree64a874b14050fe24d3bbc1bc13cd293abf8ae018 /Core/MdePkg/Include/Protocol/SmmStatusCode.h
parent7f05fa00f73038b425002566d3afe6c3ade2ccdb (diff)
downloadedk2-platforms-1760cf81e4b1847c6823ea3514a78dd120e19b6e.tar.xz
MdePkg: Move to new location
Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Guo Mang <mang.guo@intel.com>
Diffstat (limited to 'Core/MdePkg/Include/Protocol/SmmStatusCode.h')
-rw-r--r--Core/MdePkg/Include/Protocol/SmmStatusCode.h65
1 files changed, 65 insertions, 0 deletions
diff --git a/Core/MdePkg/Include/Protocol/SmmStatusCode.h b/Core/MdePkg/Include/Protocol/SmmStatusCode.h
new file mode 100644
index 0000000000..a0e71efbbf
--- /dev/null
+++ b/Core/MdePkg/Include/Protocol/SmmStatusCode.h
@@ -0,0 +1,65 @@
+/** @file
+ EFI SMM Status Code Protocol as defined in the PI 1.2 specification.
+
+ This protocol provides the basic status code services while in SMM.
+
+ Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
+ This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef _SMM_STATUS_CODE_H__
+#define _SMM_STATUS_CODE_H__
+
+
+#define EFI_SMM_STATUS_CODE_PROTOCOL_GUID \
+ { \
+ 0x6afd2b77, 0x98c1, 0x4acd, {0xa6, 0xf9, 0x8a, 0x94, 0x39, 0xde, 0xf, 0xb1} \
+ }
+
+typedef struct _EFI_SMM_STATUS_CODE_PROTOCOL EFI_SMM_STATUS_CODE_PROTOCOL;
+
+/**
+ Service to emit the status code in SMM.
+
+ The EFI_SMM_STATUS_CODE_PROTOCOL.ReportStatusCode() function enables a driver
+ to emit a status code while in SMM. The reason that there is a separate protocol definition from the
+ DXE variant of this service is that the publisher of this protocol will provide a service that is
+ capability of coexisting with a foreground operational environment, such as an operating system
+ after the termination of boot services.
+
+ @param[in] This Points to this instance of the EFI_SMM_STATUS_CODE_PROTOCOL.
+ @param[in] CodeType DIndicates the type of status code being reported.
+ @param[in] Value Describes the current status of a hardware or software entity.
+ @param[in] Instance The enumeration of a hardware or software entity within the system.
+ @param[in] CallerId This optional parameter may be used to identify the caller.
+ @param[in] Data This optional parameter may be used to pass additional data.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_INVALID_PARAMETER The function should not be completed due to a device error.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_SMM_REPORT_STATUS_CODE)(
+ IN CONST EFI_SMM_STATUS_CODE_PROTOCOL *This,
+ IN EFI_STATUS_CODE_TYPE CodeType,
+ IN EFI_STATUS_CODE_VALUE Value,
+ IN UINT32 Instance,
+ IN CONST EFI_GUID *CallerId,
+ IN EFI_STATUS_CODE_DATA *Data OPTIONAL
+ );
+
+struct _EFI_SMM_STATUS_CODE_PROTOCOL {
+ EFI_SMM_REPORT_STATUS_CODE ReportStatusCode;
+};
+
+extern EFI_GUID gEfiSmmStatusCodeProtocolGuid;
+
+#endif
+