From 5a3cb5fdb464878b1c50ef68cf179cb131325bec Mon Sep 17 00:00:00 2001 From: rsun3 Date: Wed, 2 Sep 2009 03:47:14 +0000 Subject: Add into MdePkg definitions for the EFI SMM Status Code Protocol as defined in the PI 1.2 specification. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9223 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Protocol/SmmStatusCode.h | 67 +++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 MdePkg/Include/Protocol/SmmStatusCode.h (limited to 'MdePkg/Include/Protocol/SmmStatusCode.h') diff --git a/MdePkg/Include/Protocol/SmmStatusCode.h b/MdePkg/Include/Protocol/SmmStatusCode.h new file mode 100644 index 0000000000..eec231ab56 --- /dev/null +++ b/MdePkg/Include/Protocol/SmmStatusCode.h @@ -0,0 +1,67 @@ +/** @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, Intel Corporation + All rights reserved. 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__ + +#include +#include + +#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 + -- cgit v1.2.3