mirror of https://github.com/acidanthera/audk.git
Move non-framework status code library instances to MdeModulePkg.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9630 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xli24
parent
c5631cef42
commit
d42aba9882
|
|
@ -1,71 +0,0 @@
|
||||||
/** @file
|
|
||||||
OEM hook status code library. Platform can implement an instance to
|
|
||||||
initialize the OEM devices to report status code information.
|
|
||||||
|
|
||||||
Copyright (c) 2006 - 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 __OEM_HOOK_STATUSCODE_LIB__
|
|
||||||
#define __OEM_HOOK_STATUSCODE_LIB__
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Initialize OEM status code device .
|
|
||||||
|
|
||||||
|
|
||||||
@return Status of initialization of OEM status code device.
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
OemHookStatusCodeInitialize (
|
|
||||||
VOID
|
|
||||||
);
|
|
||||||
|
|
||||||
/**
|
|
||||||
Report status code to OEM device.
|
|
||||||
|
|
||||||
@param CodeType Indicates the type of status code being reported.
|
|
||||||
|
|
||||||
@param Value Describes the current status of a hardware or software entity.
|
|
||||||
This includes both an operation and classification information about the class and subclass.
|
|
||||||
For progress codes, the operation is the current activity.
|
|
||||||
For error codes, it is the exception. For debug codes, it is not defined at this time.
|
|
||||||
Specific values are discussed in the Intel Platform Innovation Framework for EFI Status Code Specification.
|
|
||||||
|
|
||||||
@param Instance The enumeration of a hardware or software entity within the system.
|
|
||||||
A system may contain multiple entities that match a class/subclass pairing.
|
|
||||||
The instance differentiates between them. An instance of 0 indicates that instance information is unavailable,
|
|
||||||
not meaningful, or not relevant. Valid instance numbers start with 1.
|
|
||||||
|
|
||||||
|
|
||||||
@param CallerId This optional parameter may be used to identify the caller.
|
|
||||||
This parameter allows the status code driver to apply different rules to different callers.
|
|
||||||
Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
|
|
||||||
|
|
||||||
|
|
||||||
@param Data This optional parameter may be used to pass additional data
|
|
||||||
|
|
||||||
@return The function always return EFI_SUCCESS.
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
OemHookStatusCodeReport (
|
|
||||||
IN EFI_STATUS_CODE_TYPE CodeType,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN UINT32 Instance,
|
|
||||||
IN EFI_GUID *CallerId, OPTIONAL
|
|
||||||
IN EFI_STATUS_CODE_DATA *Data OPTIONAL
|
|
||||||
);
|
|
||||||
|
|
||||||
#endif // __OEM_HOOK_STATUSCODE_LIB__
|
|
||||||
|
|
||||||
|
|
@ -24,9 +24,6 @@
|
||||||
Include # Root include for the package
|
Include # Root include for the package
|
||||||
|
|
||||||
[LibraryClasses]
|
[LibraryClasses]
|
||||||
## @libraryclass OEM status code libary is used to report status code to OEM device.
|
|
||||||
OemHookStatusCodeLib|Include/Library/OemHookStatusCodeLib.h
|
|
||||||
|
|
||||||
## @libraryclass Platform BDS library definition about platform specific behavior.
|
## @libraryclass Platform BDS library definition about platform specific behavior.
|
||||||
PlatformBdsLib|Include/Library/PlatformBdsLib.h
|
PlatformBdsLib|Include/Library/PlatformBdsLib.h
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,6 @@
|
||||||
PrintLib|MdePkg/Library/BasePrintLib/BasePrintLib.inf
|
PrintLib|MdePkg/Library/BasePrintLib/BasePrintLib.inf
|
||||||
TimerLib|MdePkg/Library/BaseTimerLibNullTemplate/BaseTimerLibNullTemplate.inf
|
TimerLib|MdePkg/Library/BaseTimerLibNullTemplate/BaseTimerLibNullTemplate.inf
|
||||||
UefiDecompressLib|MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.inf
|
UefiDecompressLib|MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.inf
|
||||||
OemHookStatusCodeLib|IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.inf
|
|
||||||
SerialPortLib|MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.inf
|
SerialPortLib|MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.inf
|
||||||
S3Lib|IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.inf
|
S3Lib|IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.inf
|
||||||
RecoveryLib|IntelFrameworkModulePkg/Library/PeiRecoveryLib/PeiRecoveryLib.inf
|
RecoveryLib|IntelFrameworkModulePkg/Library/PeiRecoveryLib/PeiRecoveryLib.inf
|
||||||
|
|
@ -66,6 +65,7 @@
|
||||||
CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf
|
CapsuleLib|MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.inf
|
||||||
PeCoffGetEntryPointLib|MdePkg/Library/BasePeCoffGetEntryPointLib/BasePeCoffGetEntryPointLib.inf
|
PeCoffGetEntryPointLib|MdePkg/Library/BasePeCoffGetEntryPointLib/BasePeCoffGetEntryPointLib.inf
|
||||||
DxeServicesLib|MdePkg/Library/DxeServicesLib/DxeServicesLib.inf
|
DxeServicesLib|MdePkg/Library/DxeServicesLib/DxeServicesLib.inf
|
||||||
|
ReportStatusCodeLib|MdePkg/Library/BaseReportStatusCodeLibNull/BaseReportStatusCodeLibNull.inf
|
||||||
|
|
||||||
[LibraryClasses.common.PEIM]
|
[LibraryClasses.common.PEIM]
|
||||||
HobLib|MdePkg/Library/PeiHobLib/PeiHobLib.inf
|
HobLib|MdePkg/Library/PeiHobLib/PeiHobLib.inf
|
||||||
|
|
@ -76,7 +76,6 @@
|
||||||
PeiServicesLib|MdePkg/Library/PeiServicesLib/PeiServicesLib.inf
|
PeiServicesLib|MdePkg/Library/PeiServicesLib/PeiServicesLib.inf
|
||||||
BaseMemoryLib|MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf
|
BaseMemoryLib|MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf
|
||||||
MemoryAllocationLib|MdePkg/Library/PeiMemoryAllocationLib/PeiMemoryAllocationLib.inf
|
MemoryAllocationLib|MdePkg/Library/PeiMemoryAllocationLib/PeiMemoryAllocationLib.inf
|
||||||
ReportStatusCodeLib|IntelFrameworkModulePkg/Library/PeiReportStatusCodeLib/PeiReportStatusCodeLib.inf
|
|
||||||
|
|
||||||
[LibraryClasses.common.DXE_DRIVER]
|
[LibraryClasses.common.DXE_DRIVER]
|
||||||
HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf
|
HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf
|
||||||
|
|
@ -89,7 +88,6 @@
|
||||||
UefiLib|MdePkg/Library/UefiLib/UefiLib.inf
|
UefiLib|MdePkg/Library/UefiLib/UefiLib.inf
|
||||||
UefiRuntimeServicesTableLib|MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.inf
|
UefiRuntimeServicesTableLib|MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.inf
|
||||||
DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.inf
|
DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.inf
|
||||||
ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
|
|
||||||
IoLib|IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf
|
IoLib|IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf
|
||||||
|
|
||||||
[LibraryClasses.common.DXE_RUNTIME_DRIVER]
|
[LibraryClasses.common.DXE_RUNTIME_DRIVER]
|
||||||
|
|
@ -102,7 +100,6 @@
|
||||||
UefiLib|MdePkg/Library/UefiLib/UefiLib.inf
|
UefiLib|MdePkg/Library/UefiLib/UefiLib.inf
|
||||||
UefiRuntimeLib|MdePkg/Library/UefiRuntimeLib/UefiRuntimeLib.inf
|
UefiRuntimeLib|MdePkg/Library/UefiRuntimeLib/UefiRuntimeLib.inf
|
||||||
UefiRuntimeServicesTableLib|MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.inf
|
UefiRuntimeServicesTableLib|MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.inf
|
||||||
ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
|
|
||||||
IoLib|IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf
|
IoLib|IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf
|
||||||
|
|
||||||
[LibraryClasses.common.UEFI_DRIVER]
|
[LibraryClasses.common.UEFI_DRIVER]
|
||||||
|
|
@ -116,12 +113,10 @@
|
||||||
UefiLib|MdePkg/Library/UefiLib/UefiLib.inf
|
UefiLib|MdePkg/Library/UefiLib/UefiLib.inf
|
||||||
UefiRuntimeServicesTableLib|MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.inf
|
UefiRuntimeServicesTableLib|MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.inf
|
||||||
DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.inf
|
DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.inf
|
||||||
ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
|
|
||||||
IoLib|IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf
|
IoLib|IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf
|
||||||
|
|
||||||
[LibraryClasses.common.DXE_SMM_DRIVER]
|
[LibraryClasses.common.DXE_SMM_DRIVER]
|
||||||
SmmServicesTableLib|MdePkg/Library/SmmServicesTableLib/SmmServicesTableLib.inf
|
SmmServicesTableLib|MdePkg/Library/SmmServicesTableLib/SmmServicesTableLib.inf
|
||||||
ReportStatusCodeLib|IntelFrameworkModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCodeLib.inf
|
|
||||||
UefiDriverEntryPoint|MdePkg/Library/UefiDriverEntryPoint/UefiDriverEntryPoint.inf
|
UefiDriverEntryPoint|MdePkg/Library/UefiDriverEntryPoint/UefiDriverEntryPoint.inf
|
||||||
PcdLib|MdePkg/Library/DxePcdLib/DxePcdLib.inf
|
PcdLib|MdePkg/Library/DxePcdLib/DxePcdLib.inf
|
||||||
UefiBootServicesTableLib|MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.inf
|
UefiBootServicesTableLib|MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.inf
|
||||||
|
|
@ -136,7 +131,6 @@
|
||||||
gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnosticsDisable|FALSE
|
gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnosticsDisable|FALSE
|
||||||
gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable|FALSE
|
gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable|FALSE
|
||||||
gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable|FALSE
|
gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable|FALSE
|
||||||
gEfiMdeModulePkgTokenSpaceGuid.PcdStatusCodeUseSerial|FALSE
|
|
||||||
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSerialUseHalfHandshake|FALSE
|
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSerialUseHalfHandshake|FALSE
|
||||||
|
|
||||||
[PcdsFixedAtBuild.common]
|
[PcdsFixedAtBuild.common]
|
||||||
|
|
@ -158,12 +152,6 @@
|
||||||
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits|1
|
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits|1
|
||||||
gEfiMdePkgTokenSpaceGuid.PcdDefaultTerminalType|0
|
gEfiMdePkgTokenSpaceGuid.PcdDefaultTerminalType|0
|
||||||
|
|
||||||
[PcdsDynamicDefault.PEIM.DEFAULT]
|
|
||||||
gEfiMdeModulePkgTokenSpaceGuid.PcdStatusCodeMemorySize|1
|
|
||||||
|
|
||||||
[PcdsDynamicDefault.DXE_RUNTIME_DRIVER.DEFAULT]
|
|
||||||
gEfiMdeModulePkgTokenSpaceGuid.PcdStatusCodeMemorySize|4
|
|
||||||
|
|
||||||
[PcdsFixedAtBuild.IPF]
|
[PcdsFixedAtBuild.IPF]
|
||||||
gEfiMdePkgTokenSpaceGuid.PcdIoBlockBaseAddressForIpf|0x0ffffc000000
|
gEfiMdePkgTokenSpaceGuid.PcdIoBlockBaseAddressForIpf|0x0ffffc000000
|
||||||
|
|
||||||
|
|
@ -189,13 +177,10 @@
|
||||||
[Components.common]
|
[Components.common]
|
||||||
IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
|
IntelFrameworkModulePkg/Library/BaseUefiTianoCustomDecompressLib/BaseUefiTianoCustomDecompressLib.inf
|
||||||
IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/LzmaCustomDecompressLib.inf
|
IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/LzmaCustomDecompressLib.inf
|
||||||
IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.inf
|
|
||||||
IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.inf
|
IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.inf
|
||||||
IntelFrameworkModulePkg/Library/PeiRecoveryLib/PeiRecoveryLib.inf
|
IntelFrameworkModulePkg/Library/PeiRecoveryLib/PeiRecoveryLib.inf
|
||||||
IntelFrameworkModulePkg/Library/PeiReportStatusCodeLib/PeiReportStatusCodeLib.inf
|
|
||||||
IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
|
IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
|
||||||
IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeReportStatusCodeLibFramework.inf
|
IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeReportStatusCodeLibFramework.inf
|
||||||
IntelFrameworkModulePkg/Library/SmmReportStatusCodeLib/SmmReportStatusCodeLib.inf
|
|
||||||
IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf
|
IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf
|
||||||
IntelFrameworkModulePkg/Library/PlatformBdsLibNull/PlatformBdsLibNull.inf
|
IntelFrameworkModulePkg/Library/PlatformBdsLibNull/PlatformBdsLibNull.inf
|
||||||
IntelFrameworkModulePkg/Library/GenericBdsLib/GenericBdsLib.inf
|
IntelFrameworkModulePkg/Library/GenericBdsLib/GenericBdsLib.inf
|
||||||
|
|
|
||||||
|
|
@ -1,58 +0,0 @@
|
||||||
#/** @file
|
|
||||||
# Instance of Report Status Code Library for PEI Phase.
|
|
||||||
#
|
|
||||||
# Instance of Report Status Code Library for PEI Phase. It first tries to report status
|
|
||||||
# code via PEI Status Code Service. If the service is not available, it then tries calling
|
|
||||||
# OEM Hook Status Code Library.
|
|
||||||
#
|
|
||||||
# Copyright (c) 2006 - 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.
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#**/
|
|
||||||
|
|
||||||
[Defines]
|
|
||||||
INF_VERSION = 0x00010005
|
|
||||||
BASE_NAME = PeiReportStatusCodeLib
|
|
||||||
FILE_GUID = 8c690838-7a22-45c4-aa58-a33e3e515cd4
|
|
||||||
MODULE_TYPE = PEIM
|
|
||||||
VERSION_STRING = 1.0
|
|
||||||
LIBRARY_CLASS = ReportStatusCodeLib|SEC PEIM PEI_CORE
|
|
||||||
|
|
||||||
#
|
|
||||||
# The following information is for reference only and not required by the build tools.
|
|
||||||
#
|
|
||||||
# VALID_ARCHITECTURES = IA32 X64 IPF EBC (EBC is for build only)
|
|
||||||
#
|
|
||||||
|
|
||||||
[Sources.common]
|
|
||||||
ReportStatusCodeLib.c
|
|
||||||
|
|
||||||
|
|
||||||
[Packages]
|
|
||||||
MdePkg/MdePkg.dec
|
|
||||||
MdeModulePkg/MdeModulePkg.dec
|
|
||||||
|
|
||||||
[LibraryClasses]
|
|
||||||
PcdLib
|
|
||||||
PeiServicesTablePointerLib
|
|
||||||
BaseMemoryLib
|
|
||||||
BaseLib
|
|
||||||
DebugLib
|
|
||||||
OemHookStatusCodeLib
|
|
||||||
|
|
||||||
|
|
||||||
[Guids]
|
|
||||||
gEfiStatusCodeSpecificDataGuid ## CONSUMES
|
|
||||||
gEfiStatusCodeDataTypeDebugGuid ## CONSUMES
|
|
||||||
|
|
||||||
|
|
||||||
[Pcd.common]
|
|
||||||
gEfiMdePkgTokenSpaceGuid.PcdReportStatusCodePropertyMask
|
|
||||||
|
|
||||||
|
|
@ -1,555 +0,0 @@
|
||||||
/** @file
|
|
||||||
Instance of Report Status Code Library for PEI Phase.
|
|
||||||
|
|
||||||
Copyright (c) 2006 - 2009, Intel Corporation<BR>
|
|
||||||
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.
|
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
||||||
#include <Guid/StatusCodeDataTypeId.h>
|
|
||||||
#include <Guid/StatusCodeDataTypeDebug.h>
|
|
||||||
|
|
||||||
#include <Library/ReportStatusCodeLib.h>
|
|
||||||
#include <Library/DebugLib.h>
|
|
||||||
#include <Library/BaseLib.h>
|
|
||||||
#include <Library/BaseMemoryLib.h>
|
|
||||||
#include <Library/PeiServicesTablePointerLib.h>
|
|
||||||
#include <Library/OemHookStatusCodeLib.h>
|
|
||||||
#include <Library/PcdLib.h>
|
|
||||||
|
|
||||||
//
|
|
||||||
// Define the maximum extended data size that is supported in the PEI phase
|
|
||||||
//
|
|
||||||
#define MAX_EXTENDED_DATA_SIZE 0x200
|
|
||||||
|
|
||||||
/**
|
|
||||||
Internal worker function that reports a status code through the PEI Status Code Service or
|
|
||||||
OEM Hook Status Code Library.
|
|
||||||
|
|
||||||
This function first tries to report status code via PEI Status Code Service. If the service
|
|
||||||
is not available, it then tries calling OEM Hook Status Code Library.
|
|
||||||
|
|
||||||
@param Type Status code type.
|
|
||||||
@param Value Status code value.
|
|
||||||
@param Instance Status code instance number.
|
|
||||||
@param CallerId Pointer to a GUID that identifies the caller of this
|
|
||||||
function. This is an optional parameter that may be
|
|
||||||
NULL.
|
|
||||||
@param Data Pointer to the extended data buffer. This is an
|
|
||||||
optional parameter that may be NULL.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The status code was reported.
|
|
||||||
@retval EFI_UNSUPPORTED Status code type is not supported.
|
|
||||||
@retval Others Failed to report status code.
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
InternalReportStatusCode (
|
|
||||||
IN EFI_STATUS_CODE_TYPE Type,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN UINT32 Instance,
|
|
||||||
IN CONST EFI_GUID *CallerId OPTIONAL,
|
|
||||||
IN EFI_STATUS_CODE_DATA *Data OPTIONAL
|
|
||||||
)
|
|
||||||
{
|
|
||||||
CONST EFI_PEI_SERVICES **PeiServices;
|
|
||||||
EFI_STATUS Status;
|
|
||||||
|
|
||||||
if ((ReportProgressCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||
|
|
||||||
(ReportErrorCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) ||
|
|
||||||
(ReportDebugCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE)) {
|
|
||||||
PeiServices = GetPeiServicesTablePointer ();
|
|
||||||
Status = (*PeiServices)->ReportStatusCode (
|
|
||||||
PeiServices,
|
|
||||||
Type,
|
|
||||||
Value,
|
|
||||||
Instance,
|
|
||||||
(EFI_GUID *)CallerId,
|
|
||||||
Data
|
|
||||||
);
|
|
||||||
if (Status == EFI_NOT_AVAILABLE_YET) {
|
|
||||||
Status = OemHookStatusCodeInitialize ();
|
|
||||||
if (!EFI_ERROR (Status)) {
|
|
||||||
return OemHookStatusCodeReport (Type, Value, Instance, (EFI_GUID *) CallerId, Data);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return Status;
|
|
||||||
}
|
|
||||||
|
|
||||||
return EFI_UNSUPPORTED;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Converts a status code to an 8-bit POST code value.
|
|
||||||
|
|
||||||
Converts the status code specified by CodeType and Value to an 8-bit POST code
|
|
||||||
and returns the 8-bit POST code in PostCode. If CodeType is an
|
|
||||||
EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode
|
|
||||||
are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits
|
|
||||||
24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.
|
|
||||||
|
|
||||||
If PostCode is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param CodeType The type of status code being converted.
|
|
||||||
@param Value The status code value being converted.
|
|
||||||
@param PostCode A pointer to the 8-bit POST code value to return.
|
|
||||||
|
|
||||||
@retval TRUE The status code specified by CodeType and Value was converted
|
|
||||||
to an 8-bit POST code and returned in PostCode.
|
|
||||||
@retval FALSE The status code specified by CodeType and Value could not be
|
|
||||||
converted to an 8-bit POST code value.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
CodeTypeToPostCode (
|
|
||||||
IN EFI_STATUS_CODE_TYPE CodeType,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
OUT UINT8 *PostCode
|
|
||||||
)
|
|
||||||
{
|
|
||||||
//
|
|
||||||
// If PostCode is NULL, then ASSERT()
|
|
||||||
//
|
|
||||||
ASSERT (PostCode != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Convert Value to an 8 bit post code
|
|
||||||
//
|
|
||||||
if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||
|
|
||||||
((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE)) {
|
|
||||||
*PostCode = (UINT8) ((((Value & EFI_STATUS_CODE_CLASS_MASK) >> 24) << 5) |
|
|
||||||
(((Value & EFI_STATUS_CODE_SUBCLASS_MASK) >> 16) & 0x1f));
|
|
||||||
return TRUE;
|
|
||||||
}
|
|
||||||
return FALSE;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Extracts ASSERT() information from a status code structure.
|
|
||||||
|
|
||||||
Converts the status code specified by CodeType, Value, and Data to the ASSERT()
|
|
||||||
arguments specified by Filename, Description, and LineNumber. If CodeType is
|
|
||||||
an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and
|
|
||||||
Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract
|
|
||||||
Filename, Description, and LineNumber from the optional data area of the
|
|
||||||
status code buffer specified by Data. The optional data area of Data contains
|
|
||||||
a Null-terminated ASCII string for the FileName, followed by a Null-terminated
|
|
||||||
ASCII string for the Description, followed by a 32-bit LineNumber. If the
|
|
||||||
ASSERT() information could be extracted from Data, then return TRUE.
|
|
||||||
Otherwise, FALSE is returned.
|
|
||||||
|
|
||||||
If Data is NULL, then ASSERT().
|
|
||||||
If Filename is NULL, then ASSERT().
|
|
||||||
If Description is NULL, then ASSERT().
|
|
||||||
If LineNumber is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param CodeType The type of status code being converted.
|
|
||||||
@param Value The status code value being converted.
|
|
||||||
@param Data Pointer to status code data buffer.
|
|
||||||
@param Filename Pointer to the source file name that generated the ASSERT().
|
|
||||||
@param Description Pointer to the description of the ASSERT().
|
|
||||||
@param LineNumber Pointer to source line number that generated the ASSERT().
|
|
||||||
|
|
||||||
@retval TRUE The status code specified by CodeType, Value, and Data was
|
|
||||||
converted ASSERT() arguments specified by Filename, Description,
|
|
||||||
and LineNumber.
|
|
||||||
@retval FALSE The status code specified by CodeType, Value, and Data could
|
|
||||||
not be converted to ASSERT() arguments.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCodeExtractAssertInfo (
|
|
||||||
IN EFI_STATUS_CODE_TYPE CodeType,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN CONST EFI_STATUS_CODE_DATA *Data,
|
|
||||||
OUT CHAR8 **Filename,
|
|
||||||
OUT CHAR8 **Description,
|
|
||||||
OUT UINT32 *LineNumber
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_DEBUG_ASSERT_DATA *AssertData;
|
|
||||||
|
|
||||||
ASSERT (Data != NULL);
|
|
||||||
ASSERT (Filename != NULL);
|
|
||||||
ASSERT (Description != NULL);
|
|
||||||
ASSERT (LineNumber != NULL);
|
|
||||||
|
|
||||||
if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) &&
|
|
||||||
((CodeType & EFI_STATUS_CODE_SEVERITY_MASK) == EFI_ERROR_UNRECOVERED) &&
|
|
||||||
((Value & EFI_STATUS_CODE_OPERATION_MASK) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE)) {
|
|
||||||
AssertData = (EFI_DEBUG_ASSERT_DATA *)(Data + 1);
|
|
||||||
*Filename = (CHAR8 *)(AssertData + 1);
|
|
||||||
*Description = *Filename + AsciiStrLen (*Filename) + 1;
|
|
||||||
*LineNumber = AssertData->LineNumber;
|
|
||||||
return TRUE;
|
|
||||||
}
|
|
||||||
return FALSE;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Extracts DEBUG() information from a status code structure.
|
|
||||||
|
|
||||||
Converts the status code specified by Data to the DEBUG() arguments specified
|
|
||||||
by ErrorLevel, Marker, and Format. If type GUID in Data is
|
|
||||||
EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and
|
|
||||||
Format from the optional data area of the status code buffer specified by Data.
|
|
||||||
The optional data area of Data contains a 32-bit ErrorLevel followed by Marker
|
|
||||||
which is 12 UINTN parameters, followed by a Null-terminated ASCII string for
|
|
||||||
the Format. If the DEBUG() information could be extracted from Data, then
|
|
||||||
return TRUE. Otherwise, FALSE is returned.
|
|
||||||
|
|
||||||
If Data is NULL, then ASSERT().
|
|
||||||
If ErrorLevel is NULL, then ASSERT().
|
|
||||||
If Marker is NULL, then ASSERT().
|
|
||||||
If Format is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param Data Pointer to status code data buffer.
|
|
||||||
@param ErrorLevel Pointer to error level mask for a debug message.
|
|
||||||
@param Marker Pointer to the variable argument list associated with Format.
|
|
||||||
@param Format Pointer to a Null-terminated ASCII format string of a
|
|
||||||
debug message.
|
|
||||||
|
|
||||||
@retval TRUE The status code specified by Data was converted DEBUG() arguments
|
|
||||||
specified by ErrorLevel, Marker, and Format.
|
|
||||||
@retval FALSE The status code specified by Data could not be converted to
|
|
||||||
DEBUG() arguments.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCodeExtractDebugInfo (
|
|
||||||
IN CONST EFI_STATUS_CODE_DATA *Data,
|
|
||||||
OUT UINT32 *ErrorLevel,
|
|
||||||
OUT BASE_LIST *Marker,
|
|
||||||
OUT CHAR8 **Format
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_DEBUG_INFO *DebugInfo;
|
|
||||||
|
|
||||||
ASSERT (Data != NULL);
|
|
||||||
ASSERT (ErrorLevel != NULL);
|
|
||||||
ASSERT (Marker != NULL);
|
|
||||||
ASSERT (Format != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE
|
|
||||||
//
|
|
||||||
if (!CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid)) {
|
|
||||||
return FALSE;
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Retrieve the debug information from the status code record
|
|
||||||
//
|
|
||||||
DebugInfo = (EFI_DEBUG_INFO *)(Data + 1);
|
|
||||||
|
|
||||||
*ErrorLevel = DebugInfo->ErrorLevel;
|
|
||||||
|
|
||||||
//
|
|
||||||
// The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments
|
|
||||||
// of format in DEBUG string. Its address is returned in Marker and has to be 64-bit aligned.
|
|
||||||
// It must be noticed that EFI_DEBUG_INFO follows EFI_STATUS_CODE_DATA, whose size is
|
|
||||||
// 20 bytes. The size of EFI_DEBUG_INFO is 4 bytes, so we can ensure that Marker
|
|
||||||
// returned is 64-bit aligned.
|
|
||||||
// 64-bit aligned is a must, otherwise retrieving 64-bit parameter from BASE_LIST will
|
|
||||||
// cause unalignment exception.
|
|
||||||
//
|
|
||||||
*Marker = (BASE_LIST) (DebugInfo + 1);
|
|
||||||
*Format = (CHAR8 *)(((UINT64 *)*Marker) + 12);
|
|
||||||
|
|
||||||
return TRUE;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Reports a status code.
|
|
||||||
|
|
||||||
Reports the status code specified by the parameters Type and Value. Status
|
|
||||||
code also require an instance, caller ID, and extended data. This function
|
|
||||||
passed in a zero instance, NULL extended data, and a caller ID of
|
|
||||||
gEfiCallerIdGuid, which is the GUID for the module.
|
|
||||||
|
|
||||||
ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode()
|
|
||||||
is called while processing another any other Report Status Code Library function,
|
|
||||||
then ReportStatusCode() must return immediately.
|
|
||||||
|
|
||||||
@param Type Status code type.
|
|
||||||
@param Value Status code value.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The status code was reported.
|
|
||||||
@retval EFI_DEVICE_ERROR There status code could not be reported due to a
|
|
||||||
device error.
|
|
||||||
@retval EFI_UNSUPPORTED Report status code is not supported
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCode (
|
|
||||||
IN EFI_STATUS_CODE_TYPE Type,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return InternalReportStatusCode (Type, Value, 0, &gEfiCallerIdGuid, NULL);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Reports a status code with a Device Path Protocol as the extended data.
|
|
||||||
|
|
||||||
Allocates and fills in the extended data section of a status code with the
|
|
||||||
Device Path Protocol specified by DevicePath. This function is responsible
|
|
||||||
for allocating a buffer large enough for the standard header and the device
|
|
||||||
path. The standard header is filled in with a GUID of
|
|
||||||
gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero
|
|
||||||
instance and a caller ID of gEfiCallerIdGuid.
|
|
||||||
|
|
||||||
ReportStatusCodeWithDevicePath()must actively prevent recursion. If
|
|
||||||
ReportStatusCodeWithDevicePath() is called while processing another any other
|
|
||||||
Report Status Code Library function, then ReportStatusCodeWithDevicePath()
|
|
||||||
must return EFI_DEVICE_ERROR immediately.
|
|
||||||
|
|
||||||
If DevicePath is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param Type Status code type.
|
|
||||||
@param Value Status code value.
|
|
||||||
@param DevicePath Pointer to the Device Path Protocol to be reported.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The status code was reported with the extended
|
|
||||||
data specified by DevicePath.
|
|
||||||
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
|
|
||||||
extended data section.
|
|
||||||
@retval EFI_UNSUPPORTED Report status code is not supported
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCodeWithDevicePath (
|
|
||||||
IN EFI_STATUS_CODE_TYPE Type,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath
|
|
||||||
)
|
|
||||||
{
|
|
||||||
ASSERT (DevicePath != NULL);
|
|
||||||
//
|
|
||||||
// EFI_UNSUPPORTED is returned for device path is not supported in PEI phase.
|
|
||||||
//
|
|
||||||
return EFI_UNSUPPORTED;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Reports a status code with an extended data buffer.
|
|
||||||
|
|
||||||
Allocates and fills in the extended data section of a status code with the
|
|
||||||
extended data specified by ExtendedData and ExtendedDataSize. ExtendedData
|
|
||||||
is assumed to be one of the data structures specified in Related Definitions.
|
|
||||||
These data structure do not have the standard header, so this function is
|
|
||||||
responsible for allocating a buffer large enough for the standard header and
|
|
||||||
the extended data passed into this function. The standard header is filled
|
|
||||||
in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported
|
|
||||||
with a zero instance and a caller ID of gEfiCallerIdGuid.
|
|
||||||
|
|
||||||
ReportStatusCodeWithExtendedData()must actively prevent recursion. If
|
|
||||||
ReportStatusCodeWithExtendedData() is called while processing another any other
|
|
||||||
Report Status Code Library function, then ReportStatusCodeWithExtendedData()
|
|
||||||
must return EFI_DEVICE_ERROR immediately.
|
|
||||||
|
|
||||||
If ExtendedData is NULL, then ASSERT().
|
|
||||||
If ExtendedDataSize is 0, then ASSERT().
|
|
||||||
|
|
||||||
@param Type Status code type.
|
|
||||||
@param Value Status code value.
|
|
||||||
@param ExtendedData Pointer to the extended data buffer to be reported.
|
|
||||||
@param ExtendedDataSize The size, in bytes, of the extended data buffer to
|
|
||||||
be reported.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The status code was reported with the extended
|
|
||||||
data specified by ExtendedData and ExtendedDataSize.
|
|
||||||
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
|
|
||||||
extended data section.
|
|
||||||
@retval EFI_UNSUPPORTED Report status code is not supported
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCodeWithExtendedData (
|
|
||||||
IN EFI_STATUS_CODE_TYPE Type,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN CONST VOID *ExtendedData,
|
|
||||||
IN UINTN ExtendedDataSize
|
|
||||||
)
|
|
||||||
{
|
|
||||||
ASSERT (ExtendedData != NULL);
|
|
||||||
ASSERT (ExtendedDataSize != 0);
|
|
||||||
return ReportStatusCodeEx (
|
|
||||||
Type,
|
|
||||||
Value,
|
|
||||||
0,
|
|
||||||
NULL,
|
|
||||||
NULL,
|
|
||||||
ExtendedData,
|
|
||||||
ExtendedDataSize
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Reports a status code with full parameters.
|
|
||||||
|
|
||||||
The function reports a status code. If ExtendedData is NULL and ExtendedDataSize
|
|
||||||
is 0, then an extended data buffer is not reported. If ExtendedData is not
|
|
||||||
NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.
|
|
||||||
ExtendedData is assumed not have the standard status code header, so this function
|
|
||||||
is responsible for allocating a buffer large enough for the standard header and
|
|
||||||
the extended data passed into this function. The standard header is filled in
|
|
||||||
with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a
|
|
||||||
GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with
|
|
||||||
an instance specified by Instance and a caller ID specified by CallerId. If
|
|
||||||
CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.
|
|
||||||
|
|
||||||
ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx()
|
|
||||||
is called while processing another any other Report Status Code Library function,
|
|
||||||
then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.
|
|
||||||
|
|
||||||
If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
|
|
||||||
If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
|
|
||||||
|
|
||||||
@param Type Status code type.
|
|
||||||
@param Value Status code value.
|
|
||||||
@param Instance Status code instance number.
|
|
||||||
@param CallerId Pointer to a GUID that identifies the caller of this
|
|
||||||
function. If this parameter is NULL, then a caller
|
|
||||||
ID of gEfiCallerIdGuid is used.
|
|
||||||
@param ExtendedDataGuid Pointer to the GUID for the extended data buffer.
|
|
||||||
If this parameter is NULL, then a the status code
|
|
||||||
standard header is filled in with
|
|
||||||
gEfiStatusCodeSpecificDataGuid.
|
|
||||||
@param ExtendedData Pointer to the extended data buffer. This is an
|
|
||||||
optional parameter that may be NULL.
|
|
||||||
@param ExtendedDataSize The size, in bytes, of the extended data buffer.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The status code was reported.
|
|
||||||
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate
|
|
||||||
the extended data section if it was specified.
|
|
||||||
@retval EFI_UNSUPPORTED Report status code is not supported
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCodeEx (
|
|
||||||
IN EFI_STATUS_CODE_TYPE Type,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN UINT32 Instance,
|
|
||||||
IN CONST EFI_GUID *CallerId OPTIONAL,
|
|
||||||
IN CONST EFI_GUID *ExtendedDataGuid OPTIONAL,
|
|
||||||
IN CONST VOID *ExtendedData OPTIONAL,
|
|
||||||
IN UINTN ExtendedDataSize
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_STATUS_CODE_DATA *StatusCodeData;
|
|
||||||
UINT64 Buffer[MAX_EXTENDED_DATA_SIZE / sizeof (UINT64)];
|
|
||||||
|
|
||||||
//
|
|
||||||
// If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
|
|
||||||
//
|
|
||||||
ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));
|
|
||||||
//
|
|
||||||
// If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
|
|
||||||
//
|
|
||||||
ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));
|
|
||||||
|
|
||||||
if (ExtendedDataSize > (MAX_EXTENDED_DATA_SIZE - sizeof (EFI_STATUS_CODE_DATA))) {
|
|
||||||
return EFI_OUT_OF_RESOURCES;
|
|
||||||
}
|
|
||||||
StatusCodeData = (EFI_STATUS_CODE_DATA *)Buffer;
|
|
||||||
StatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);
|
|
||||||
StatusCodeData->Size = (UINT16)ExtendedDataSize;
|
|
||||||
if (ExtendedDataGuid == NULL) {
|
|
||||||
ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;
|
|
||||||
}
|
|
||||||
CopyGuid (&StatusCodeData->Type, ExtendedDataGuid);
|
|
||||||
if (ExtendedData != NULL) {
|
|
||||||
CopyMem (StatusCodeData + 1, ExtendedData, ExtendedDataSize);
|
|
||||||
}
|
|
||||||
if (CallerId == NULL) {
|
|
||||||
CallerId = &gEfiCallerIdGuid;
|
|
||||||
}
|
|
||||||
return InternalReportStatusCode (Type, Value, Instance, CallerId, StatusCodeData);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled
|
|
||||||
|
|
||||||
This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
|
|
||||||
bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is set.
|
|
||||||
@retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportProgressCodeEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return (BOOLEAN) ((PcdGet8 (PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Returns TRUE if status codes of type EFI_ERROR_CODE are enabled
|
|
||||||
|
|
||||||
This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
|
|
||||||
bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is set.
|
|
||||||
@retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportErrorCodeEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return (BOOLEAN) ((PcdGet8 (PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled
|
|
||||||
|
|
||||||
This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
|
|
||||||
bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is set.
|
|
||||||
@retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportDebugCodeEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return (BOOLEAN) ((PcdGet8 (PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
@ -1,549 +0,0 @@
|
||||||
/** @file
|
|
||||||
Report Status Code Library for SMM Phase.
|
|
||||||
|
|
||||||
Copyright (c) 2009, Intel Corporation<BR>
|
|
||||||
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.
|
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
||||||
#include <Library/ReportStatusCodeLib.h>
|
|
||||||
#include <Library/DebugLib.h>
|
|
||||||
#include <Library/SmmServicesTableLib.h>
|
|
||||||
#include <Library/BaseLib.h>
|
|
||||||
#include <Library/BaseMemoryLib.h>
|
|
||||||
#include <Library/PcdLib.h>
|
|
||||||
|
|
||||||
#include <Guid/StatusCodeDataTypeId.h>
|
|
||||||
#include <Guid/StatusCodeDataTypeDebug.h>
|
|
||||||
#include <Protocol/SmmStatusCode.h>
|
|
||||||
|
|
||||||
EFI_SMM_REPORT_STATUS_CODE mReportStatusCode = NULL;
|
|
||||||
EFI_SMM_STATUS_CODE_PROTOCOL *mStatusCodeProtocol = NULL;
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Locate the report status code service.
|
|
||||||
|
|
||||||
@return Function pointer to the report status code service.
|
|
||||||
NULL is returned if no status code service is available.
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_SMM_REPORT_STATUS_CODE
|
|
||||||
InternalGetReportStatusCode (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_STATUS Status;
|
|
||||||
|
|
||||||
Status = gSmst->SmmLocateProtocol (&gEfiSmmStatusCodeProtocolGuid, NULL, (VOID**)&mStatusCodeProtocol);
|
|
||||||
if (!EFI_ERROR (Status) && mStatusCodeProtocol != NULL) {
|
|
||||||
return mStatusCodeProtocol->ReportStatusCode;
|
|
||||||
}
|
|
||||||
return NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
Internal worker function that reports a status code through the status code service.
|
|
||||||
|
|
||||||
If status code service is not cached, then this function checks if status code service is
|
|
||||||
available in system. If status code service is not available, then EFI_UNSUPPORTED is
|
|
||||||
returned. If status code service is present, then it is cached in mReportStatusCode.
|
|
||||||
Finally this function reports status code through the status code service.
|
|
||||||
|
|
||||||
@param Type Status code type.
|
|
||||||
@param Value Status code value.
|
|
||||||
@param Instance Status code instance number.
|
|
||||||
@param CallerId Pointer to a GUID that identifies the caller of this
|
|
||||||
function. This is an optional parameter that may be
|
|
||||||
NULL.
|
|
||||||
@param Data Pointer to the extended data buffer. This is an
|
|
||||||
optional parameter that may be NULL.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The status code was reported.
|
|
||||||
@retval EFI_UNSUPPORTED Status code service is not available.
|
|
||||||
@retval EFI_UNSUPPORTED Status code type is not supported.
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
InternalReportStatusCode (
|
|
||||||
IN EFI_STATUS_CODE_TYPE Type,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN UINT32 Instance,
|
|
||||||
IN CONST EFI_GUID *CallerId OPTIONAL,
|
|
||||||
IN EFI_STATUS_CODE_DATA *Data OPTIONAL
|
|
||||||
)
|
|
||||||
{
|
|
||||||
if ((ReportProgressCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||
|
|
||||||
(ReportErrorCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) ||
|
|
||||||
(ReportDebugCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE)) {
|
|
||||||
//
|
|
||||||
// If mReportStatusCode is NULL, then check if status code service is available in system.
|
|
||||||
//
|
|
||||||
if (mReportStatusCode == NULL) {
|
|
||||||
mReportStatusCode = InternalGetReportStatusCode ();
|
|
||||||
if (mReportStatusCode == NULL) {
|
|
||||||
return EFI_UNSUPPORTED;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// A status code service is present in system, so pass in all the parameters to the service.
|
|
||||||
//
|
|
||||||
return (*mReportStatusCode) (mStatusCodeProtocol, Type, Value, Instance, (EFI_GUID *)CallerId, Data);
|
|
||||||
}
|
|
||||||
|
|
||||||
return EFI_UNSUPPORTED;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Converts a status code to an 8-bit POST code value.
|
|
||||||
|
|
||||||
Converts the status code specified by CodeType and Value to an 8-bit POST code
|
|
||||||
and returns the 8-bit POST code in PostCode. If CodeType is an
|
|
||||||
EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode
|
|
||||||
are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits
|
|
||||||
24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.
|
|
||||||
|
|
||||||
If PostCode is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param CodeType The type of status code being converted.
|
|
||||||
@param Value The status code value being converted.
|
|
||||||
@param PostCode A pointer to the 8-bit POST code value to return.
|
|
||||||
|
|
||||||
@retval TRUE The status code specified by CodeType and Value was converted
|
|
||||||
to an 8-bit POST code and returned in PostCode.
|
|
||||||
@retval FALSE The status code specified by CodeType and Value could not be
|
|
||||||
converted to an 8-bit POST code value.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
CodeTypeToPostCode (
|
|
||||||
IN EFI_STATUS_CODE_TYPE CodeType,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
OUT UINT8 *PostCode
|
|
||||||
)
|
|
||||||
{
|
|
||||||
//
|
|
||||||
// If PostCode is NULL, then ASSERT()
|
|
||||||
//
|
|
||||||
ASSERT (PostCode != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Convert Value to an 8 bit post code
|
|
||||||
//
|
|
||||||
if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||
|
|
||||||
((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) ) {
|
|
||||||
*PostCode = (UINT8) ((((Value & EFI_STATUS_CODE_CLASS_MASK) >> 24) << 5) |
|
|
||||||
(((Value & EFI_STATUS_CODE_SUBCLASS_MASK) >> 16) & 0x1f));
|
|
||||||
return TRUE;
|
|
||||||
}
|
|
||||||
return FALSE;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Extracts ASSERT() information from a status code structure.
|
|
||||||
|
|
||||||
Converts the status code specified by CodeType, Value, and Data to the ASSERT()
|
|
||||||
arguments specified by Filename, Description, and LineNumber. If CodeType is
|
|
||||||
an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and
|
|
||||||
Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract
|
|
||||||
Filename, Description, and LineNumber from the optional data area of the
|
|
||||||
status code buffer specified by Data. The optional data area of Data contains
|
|
||||||
a Null-terminated ASCII string for the FileName, followed by a Null-terminated
|
|
||||||
ASCII string for the Description, followed by a 32-bit LineNumber. If the
|
|
||||||
ASSERT() information could be extracted from Data, then return TRUE.
|
|
||||||
Otherwise, FALSE is returned.
|
|
||||||
|
|
||||||
If Data is NULL, then ASSERT().
|
|
||||||
If Filename is NULL, then ASSERT().
|
|
||||||
If Description is NULL, then ASSERT().
|
|
||||||
If LineNumber is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param CodeType The type of status code being converted.
|
|
||||||
@param Value The status code value being converted.
|
|
||||||
@param Data Pointer to status code data buffer.
|
|
||||||
@param Filename Pointer to the source file name that generated the ASSERT().
|
|
||||||
@param Description Pointer to the description of the ASSERT().
|
|
||||||
@param LineNumber Pointer to source line number that generated the ASSERT().
|
|
||||||
|
|
||||||
@retval TRUE The status code specified by CodeType, Value, and Data was
|
|
||||||
converted ASSERT() arguments specified by Filename, Description,
|
|
||||||
and LineNumber.
|
|
||||||
@retval FALSE The status code specified by CodeType, Value, and Data could
|
|
||||||
not be converted to ASSERT() arguments.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCodeExtractAssertInfo (
|
|
||||||
IN EFI_STATUS_CODE_TYPE CodeType,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN CONST EFI_STATUS_CODE_DATA *Data,
|
|
||||||
OUT CHAR8 **Filename,
|
|
||||||
OUT CHAR8 **Description,
|
|
||||||
OUT UINT32 *LineNumber
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_DEBUG_ASSERT_DATA *AssertData;
|
|
||||||
|
|
||||||
ASSERT (Data != NULL);
|
|
||||||
ASSERT (Filename != NULL);
|
|
||||||
ASSERT (Description != NULL);
|
|
||||||
ASSERT (LineNumber != NULL);
|
|
||||||
|
|
||||||
if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) &&
|
|
||||||
((CodeType & EFI_STATUS_CODE_SEVERITY_MASK) == EFI_ERROR_UNRECOVERED) &&
|
|
||||||
((Value & EFI_STATUS_CODE_OPERATION_MASK) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE)) {
|
|
||||||
AssertData = (EFI_DEBUG_ASSERT_DATA *)(Data + 1);
|
|
||||||
*Filename = (CHAR8 *)(AssertData + 1);
|
|
||||||
*Description = *Filename + AsciiStrLen (*Filename) + 1;
|
|
||||||
*LineNumber = AssertData->LineNumber;
|
|
||||||
return TRUE;
|
|
||||||
}
|
|
||||||
return FALSE;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Extracts DEBUG() information from a status code structure.
|
|
||||||
|
|
||||||
Converts the status code specified by Data to the DEBUG() arguments specified
|
|
||||||
by ErrorLevel, Marker, and Format. If type GUID in Data is
|
|
||||||
EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and
|
|
||||||
Format from the optional data area of the status code buffer specified by Data.
|
|
||||||
The optional data area of Data contains a 32-bit ErrorLevel followed by Marker
|
|
||||||
which is 12 UINTN parameters, followed by a Null-terminated ASCII string for
|
|
||||||
the Format. If the DEBUG() information could be extracted from Data, then
|
|
||||||
return TRUE. Otherwise, FALSE is returned.
|
|
||||||
|
|
||||||
If Data is NULL, then ASSERT().
|
|
||||||
If ErrorLevel is NULL, then ASSERT().
|
|
||||||
If Marker is NULL, then ASSERT().
|
|
||||||
If Format is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param Data Pointer to status code data buffer.
|
|
||||||
@param ErrorLevel Pointer to error level mask for a debug message.
|
|
||||||
@param Marker Pointer to the variable argument list associated with Format.
|
|
||||||
@param Format Pointer to a Null-terminated ASCII format string of a
|
|
||||||
debug message.
|
|
||||||
|
|
||||||
@retval TRUE The status code specified by Data was converted DEBUG() arguments
|
|
||||||
specified by ErrorLevel, Marker, and Format.
|
|
||||||
@retval FALSE The status code specified by Data could not be converted to
|
|
||||||
DEBUG() arguments.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCodeExtractDebugInfo (
|
|
||||||
IN CONST EFI_STATUS_CODE_DATA *Data,
|
|
||||||
OUT UINT32 *ErrorLevel,
|
|
||||||
OUT BASE_LIST *Marker,
|
|
||||||
OUT CHAR8 **Format
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_DEBUG_INFO *DebugInfo;
|
|
||||||
|
|
||||||
ASSERT (Data != NULL);
|
|
||||||
ASSERT (ErrorLevel != NULL);
|
|
||||||
ASSERT (Marker != NULL);
|
|
||||||
ASSERT (Format != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE
|
|
||||||
//
|
|
||||||
if (!CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid)) {
|
|
||||||
return FALSE;
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Retrieve the debug information from the status code record
|
|
||||||
//
|
|
||||||
DebugInfo = (EFI_DEBUG_INFO *)(Data + 1);
|
|
||||||
|
|
||||||
*ErrorLevel = DebugInfo->ErrorLevel;
|
|
||||||
|
|
||||||
//
|
|
||||||
// The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments
|
|
||||||
// of format in DEBUG string. Its address is returned in Marker and has to be 64-bit aligned.
|
|
||||||
// It must be noticed that EFI_DEBUG_INFO follows EFI_STATUS_CODE_DATA, whose size is
|
|
||||||
// 20 bytes. The size of EFI_DEBUG_INFO is 4 bytes, so we can ensure that Marker
|
|
||||||
// returned is 64-bit aligned.
|
|
||||||
// 64-bit aligned is a must, otherwise retrieving 64-bit parameter from BASE_LIST will
|
|
||||||
// cause unalignment exception.
|
|
||||||
//
|
|
||||||
*Marker = (BASE_LIST) (DebugInfo + 1);
|
|
||||||
*Format = (CHAR8 *)(((UINT64 *)*Marker) + 12);
|
|
||||||
|
|
||||||
return TRUE;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Reports a status code.
|
|
||||||
|
|
||||||
Reports the status code specified by the parameters Type and Value. Status
|
|
||||||
code also require an instance, caller ID, and extended data. This function
|
|
||||||
passed in a zero instance, NULL extended data, and a caller ID of
|
|
||||||
gEfiCallerIdGuid, which is the GUID for the module.
|
|
||||||
|
|
||||||
ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode()
|
|
||||||
is called while processing another any other Report Status Code Library function,
|
|
||||||
then ReportStatusCode() must return immediately.
|
|
||||||
|
|
||||||
@param Type Status code type.
|
|
||||||
@param Value Status code value.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The status code was reported.
|
|
||||||
@retval EFI_DEVICE_ERROR There status code could not be reported due to a
|
|
||||||
device error.
|
|
||||||
@retval EFI_UNSUPPORTED Report status code is not supported
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCode (
|
|
||||||
IN EFI_STATUS_CODE_TYPE Type,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return InternalReportStatusCode (Type, Value, 0, &gEfiCallerIdGuid, NULL);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Reports a status code with an extended data buffer.
|
|
||||||
|
|
||||||
Allocates and fills in the extended data section of a status code with the
|
|
||||||
extended data specified by ExtendedData and ExtendedDataSize. ExtendedData
|
|
||||||
is assumed to be one of the data structures specified in Related Definitions.
|
|
||||||
These data structure do not have the standard header, so this function is
|
|
||||||
responsible for allocating a buffer large enough for the standard header and
|
|
||||||
the extended data passed into this function. The standard header is filled
|
|
||||||
in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported
|
|
||||||
with a zero instance and a caller ID of gEfiCallerIdGuid.
|
|
||||||
|
|
||||||
ReportStatusCodeWithExtendedData()must actively prevent recursion. If
|
|
||||||
ReportStatusCodeWithExtendedData() is called while processing another any other
|
|
||||||
Report Status Code Library function, then ReportStatusCodeWithExtendedData()
|
|
||||||
must return EFI_DEVICE_ERROR immediately.
|
|
||||||
|
|
||||||
If ExtendedData is NULL, then ASSERT().
|
|
||||||
If ExtendedDataSize is 0, then ASSERT().
|
|
||||||
|
|
||||||
@param Type Status code type.
|
|
||||||
@param Value Status code value.
|
|
||||||
@param ExtendedData Pointer to the extended data buffer to be reported.
|
|
||||||
@param ExtendedDataSize The size, in bytes, of the extended data buffer to
|
|
||||||
be reported.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The status code was reported with the extended
|
|
||||||
data specified by ExtendedData and ExtendedDataSize.
|
|
||||||
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
|
|
||||||
extended data section.
|
|
||||||
@retval EFI_UNSUPPORTED Report status code is not supported
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCodeWithExtendedData (
|
|
||||||
IN EFI_STATUS_CODE_TYPE Type,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN CONST VOID *ExtendedData,
|
|
||||||
IN UINTN ExtendedDataSize
|
|
||||||
)
|
|
||||||
{
|
|
||||||
ASSERT (ExtendedData != NULL);
|
|
||||||
ASSERT (ExtendedDataSize != 0);
|
|
||||||
return ReportStatusCodeEx (
|
|
||||||
Type,
|
|
||||||
Value,
|
|
||||||
0,
|
|
||||||
NULL,
|
|
||||||
NULL,
|
|
||||||
ExtendedData,
|
|
||||||
ExtendedDataSize
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Reports a status code with full parameters.
|
|
||||||
|
|
||||||
The function reports a status code. If ExtendedData is NULL and ExtendedDataSize
|
|
||||||
is 0, then an extended data buffer is not reported. If ExtendedData is not
|
|
||||||
NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.
|
|
||||||
ExtendedData is assumed not have the standard status code header, so this function
|
|
||||||
is responsible for allocating a buffer large enough for the standard header and
|
|
||||||
the extended data passed into this function. The standard header is filled in
|
|
||||||
with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a
|
|
||||||
GUID of gEfiStatusCodeSpecificDataGuid is used. The status code is reported with
|
|
||||||
an instance specified by Instance and a caller ID specified by CallerId. If
|
|
||||||
CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.
|
|
||||||
|
|
||||||
ReportStatusCodeEx()must actively prevent recursion. If
|
|
||||||
ReportStatusCodeEx() is called while processing another any
|
|
||||||
other Report Status Code Library function, then
|
|
||||||
ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.
|
|
||||||
|
|
||||||
If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
|
|
||||||
If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
|
|
||||||
|
|
||||||
@param Type Status code type.
|
|
||||||
@param Value Status code value.
|
|
||||||
@param Instance Status code instance number.
|
|
||||||
@param CallerId Pointer to a GUID that identifies the caller of this
|
|
||||||
function. If this parameter is NULL, then a caller
|
|
||||||
ID of gEfiCallerIdGuid is used.
|
|
||||||
@param ExtendedDataGuid Pointer to the GUID for the extended data buffer.
|
|
||||||
If this parameter is NULL, then a the status code
|
|
||||||
standard header is filled in with
|
|
||||||
gEfiStatusCodeSpecificDataGuid.
|
|
||||||
@param ExtendedData Pointer to the extended data buffer. This is an
|
|
||||||
optional parameter that may be NULL.
|
|
||||||
@param ExtendedDataSize The size, in bytes, of the extended data buffer.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The status code was reported.
|
|
||||||
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate
|
|
||||||
the extended data section if it was specified.
|
|
||||||
@retval EFI_UNSUPPORTED Report status code is not supported
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
ReportStatusCodeEx (
|
|
||||||
IN EFI_STATUS_CODE_TYPE Type,
|
|
||||||
IN EFI_STATUS_CODE_VALUE Value,
|
|
||||||
IN UINT32 Instance,
|
|
||||||
IN CONST EFI_GUID *CallerId OPTIONAL,
|
|
||||||
IN CONST EFI_GUID *ExtendedDataGuid OPTIONAL,
|
|
||||||
IN CONST VOID *ExtendedData OPTIONAL,
|
|
||||||
IN UINTN ExtendedDataSize
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_STATUS Status;
|
|
||||||
EFI_STATUS_CODE_DATA *StatusCodeData;
|
|
||||||
|
|
||||||
ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));
|
|
||||||
ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));
|
|
||||||
|
|
||||||
if (gSmst == NULL || gSmst->SmmAllocatePool == NULL || gSmst->SmmFreePool == NULL) {
|
|
||||||
return EFI_UNSUPPORTED;
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Allocate space for the Status Code Header and its buffer
|
|
||||||
//
|
|
||||||
StatusCodeData = NULL;
|
|
||||||
gSmst->SmmAllocatePool (EfiRuntimeServicesData, sizeof (EFI_STATUS_CODE_DATA) + ExtendedDataSize, (VOID **)&StatusCodeData);
|
|
||||||
if (StatusCodeData == NULL) {
|
|
||||||
return EFI_OUT_OF_RESOURCES;
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Fill in the extended data header
|
|
||||||
//
|
|
||||||
StatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);
|
|
||||||
StatusCodeData->Size = (UINT16)ExtendedDataSize;
|
|
||||||
if (ExtendedDataGuid == NULL) {
|
|
||||||
ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;
|
|
||||||
}
|
|
||||||
CopyGuid (&StatusCodeData->Type, ExtendedDataGuid);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Fill in the extended data buffer
|
|
||||||
//
|
|
||||||
if (ExtendedData != NULL) {
|
|
||||||
CopyMem (StatusCodeData + 1, ExtendedData, ExtendedDataSize);
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Report the status code
|
|
||||||
//
|
|
||||||
if (CallerId == NULL) {
|
|
||||||
CallerId = &gEfiCallerIdGuid;
|
|
||||||
}
|
|
||||||
Status = InternalReportStatusCode (Type, Value, Instance, CallerId, StatusCodeData);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Free the allocated buffer
|
|
||||||
//
|
|
||||||
gSmst->SmmFreePool (StatusCodeData);
|
|
||||||
|
|
||||||
return Status;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled
|
|
||||||
|
|
||||||
This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
|
|
||||||
bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is set.
|
|
||||||
@retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportProgressCodeEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return (BOOLEAN) ((PcdGet8 (PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Returns TRUE if status codes of type EFI_ERROR_CODE are enabled
|
|
||||||
|
|
||||||
This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
|
|
||||||
bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is set.
|
|
||||||
@retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportErrorCodeEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return (BOOLEAN) ((PcdGet8 (PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled
|
|
||||||
|
|
||||||
This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
|
|
||||||
bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is set.
|
|
||||||
@retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
|
|
||||||
PcdReportStatusCodeProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
ReportDebugCodeEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return (BOOLEAN) ((PcdGet8 (PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
@ -1,56 +0,0 @@
|
||||||
#/** @file
|
|
||||||
# SMM report status code library
|
|
||||||
#
|
|
||||||
# Retrieve status code and report status code in SMM phase
|
|
||||||
# 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.
|
|
||||||
#
|
|
||||||
#
|
|
||||||
#**/
|
|
||||||
|
|
||||||
[Defines]
|
|
||||||
INF_VERSION = 0x00010005
|
|
||||||
BASE_NAME = SmmReportStatusCodeLib
|
|
||||||
FILE_GUID = 67089D19-B3D6-4d9e-A0EB-FEDC1F83A1EE
|
|
||||||
MODULE_TYPE = DXE_SMM_DRIVER
|
|
||||||
VERSION_STRING = 1.0
|
|
||||||
PI_SPECIFICATION_VERSION = 0x0001000A
|
|
||||||
|
|
||||||
LIBRARY_CLASS = ReportStatusCodeLib| DXE_SMM_DRIVER SMM_CORE
|
|
||||||
|
|
||||||
#
|
|
||||||
# The following information is for reference only and not required by the build tools.
|
|
||||||
#
|
|
||||||
# VALID_ARCHITECTURES = IA32 X64
|
|
||||||
#
|
|
||||||
|
|
||||||
[Sources.common]
|
|
||||||
ReportStatusCodeLib.c
|
|
||||||
|
|
||||||
[Packages]
|
|
||||||
MdePkg/MdePkg.dec
|
|
||||||
MdeModulePkg/MdeModulePkg.dec
|
|
||||||
|
|
||||||
[LibraryClasses]
|
|
||||||
PcdLib
|
|
||||||
BaseMemoryLib
|
|
||||||
SmmServicesTableLib
|
|
||||||
DebugLib
|
|
||||||
UefiDriverEntryPoint
|
|
||||||
|
|
||||||
[Guids]
|
|
||||||
gEfiStatusCodeSpecificDataGuid ## CONSUMES
|
|
||||||
gEfiStatusCodeDataTypeDebugGuid ## CONSUMES
|
|
||||||
|
|
||||||
[Protocols]
|
|
||||||
gEfiSmmStatusCodeProtocolGuid ## CONSUMES
|
|
||||||
|
|
||||||
[Pcd.common]
|
|
||||||
gEfiMdePkgTokenSpaceGuid.PcdReportStatusCodePropertyMask
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue