/** @file\r
- This file declares SMM Status code Protocol.\r
+ EFI SMM Status Code Protocol as defined in the PI 1.2 specification.\r
\r
- This code abstracts SMM Status Code reporting.\r
+ This protocol provides the basic status code services while in SMM. \r
\r
- Copyright (c) 2006, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
+ Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+ 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
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
+#ifndef _SMM_STATUS_CODE_H__\r
+#define _SMM_STATUS_CODE_H__\r
+\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
+ 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
- \r
- @param CodeType Indicates the type of status code being reported.\r
- \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
- \r
- @param Instance The enumeration of a hardware or software entity within \r
- the system. Valid instance numbers start with 1.\r
- \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
- \r
- @param Data This optional parameter may be used to pass additional data.\r
-\r
- @retval EFI_SUCCESS The function completed successfully\r
- \r
- @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r
-\r
+ Service to emit the status code in SMM. \r
+\r
+ The EFI_SMM_STATUS_CODE_PROTOCOL.ReportStatusCode() function enables a driver \r
+ to emit a status code while in SMM. The reason that there is a separate protocol definition from the \r
+ DXE variant of this service is that the publisher of this protocol will provide a service that is \r
+ capability of coexisting with a foreground operational environment, such as an operating system \r
+ after the termination of boot services. \r
+\r
+ @param[in] This Points to this instance of the EFI_SMM_STATUS_CODE_PROTOCOL.\r
+ @param[in] CodeType DIndicates the type of status code being reported. \r
+ @param[in] Value Describes the current status of a hardware or software entity. \r
+ @param[in] Instance The enumeration of a hardware or software entity within the system.\r
+ @param[in] CallerId This optional parameter may be used to identify the caller.\r
+ @param[in] Data This optional parameter may be used to pass additional data.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_INVALID_PARAMETER The function should not be completed due to a device error.\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
+(EFIAPI *EFI_SMM_REPORT_STATUS_CODE)(\r
+ IN CONST 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 CONST 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
extern EFI_GUID gEfiSmmStatusCodeProtocolGuid;\r
\r
#endif\r
+\r
projects / mirror_edk2.git / blobdiff