mirror of
https://github.com/acidanthera/audk.git
synced 2025-07-30 09:04:07 +02:00
Remove 3 library instances: EdkDxeDebugLibReportStatusCode, EdkUefiDebugLibConOut and EdkUefiDebugLibStdErr in EdkModulePkg.
1) EdkUefiDebugLibConOut, EdkUefiDebugLibStdErr should be replaced by respective library instance in MdePkg 2) We will have a replacement implementation for EdkDxeDebugLibReportStatusCode to emulate the EDK I implementation with a gEfiDebugMaskProtocolGuid which allows Developer to Set debug level using SHELL command err. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2550 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qwang12
parent
39d03acf63
commit
5101d837ed
@ -6,7 +6,7 @@
|
|||||||
<Version>0.3</Version>
|
<Version>0.3</Version>
|
||||||
<Abstract>Edk Module Package Reference Implementations</Abstract>
|
<Abstract>Edk Module Package Reference Implementations</Abstract>
|
||||||
<Description>This Module provides standard reference information for EFI/Tiano implementations.</Description>
|
<Description>This Module provides standard reference information for EFI/Tiano implementations.</Description>
|
||||||
<Copyright>Copyright (c) 2006, Intel Corporation.</Copyright>
|
<Copyright>Copyright (c) 2006 - 2007, Intel Corporation.</Copyright>
|
||||||
<License>All rights reserved.
|
<License>All rights reserved.
|
||||||
This program and the accompanying materials are licensed and made available
|
This program and the accompanying materials are licensed and made available
|
||||||
under the terms and conditions of the BSD License which accompanies this distribution.
|
under the terms and conditions of the BSD License which accompanies this distribution.
|
||||||
@ -387,7 +387,6 @@
|
|||||||
<Filename>Library/DxeCoreTianoDecompressLibFromHob/DxeCoreTianoDecompressLibFromHob.msa</Filename>
|
<Filename>Library/DxeCoreTianoDecompressLibFromHob/DxeCoreTianoDecompressLibFromHob.msa</Filename>
|
||||||
<Filename>Library/DxeCoreUefiDecompressLibFromHob/DxeCoreUefiDecompressLibFromHob.msa</Filename>
|
<Filename>Library/DxeCoreUefiDecompressLibFromHob/DxeCoreUefiDecompressLibFromHob.msa</Filename>
|
||||||
<Filename>Library/DxeDebugLibSerialPort/DxeDebugLibSerialPort.msa</Filename>
|
<Filename>Library/DxeDebugLibSerialPort/DxeDebugLibSerialPort.msa</Filename>
|
||||||
<Filename>Library/EdkDxeDebugLibReportStatusCode/EdkDxeDebugLibReportStatusCode.msa</Filename>
|
|
||||||
<Filename>Library/EdkDxePeCoffLoaderFromHobLib/EdkDxePeCoffLoaderFromHobLib.msa</Filename>
|
<Filename>Library/EdkDxePeCoffLoaderFromHobLib/EdkDxePeCoffLoaderFromHobLib.msa</Filename>
|
||||||
<Filename>Library/DxePerformanceLib/DxePerformanceLib.msa</Filename>
|
<Filename>Library/DxePerformanceLib/DxePerformanceLib.msa</Filename>
|
||||||
<Filename>Library/EdkDxePrintLib/EdkDxePrintLib.msa</Filename>
|
<Filename>Library/EdkDxePrintLib/EdkDxePrintLib.msa</Filename>
|
||||||
@ -400,8 +399,6 @@
|
|||||||
<Filename>Library/EdkPeCoffLoaderLib/EdkPeCoffLoaderLib.msa</Filename>
|
<Filename>Library/EdkPeCoffLoaderLib/EdkPeCoffLoaderLib.msa</Filename>
|
||||||
<Filename>Library/PeiPerformanceLib/PeiPerformanceLib.msa</Filename>
|
<Filename>Library/PeiPerformanceLib/PeiPerformanceLib.msa</Filename>
|
||||||
<Filename>Library/EdkScsiLib/EdkScsiLib.msa</Filename>
|
<Filename>Library/EdkScsiLib/EdkScsiLib.msa</Filename>
|
||||||
<Filename>Library/EdkUefiDebugLibConOut/EdkUefiDebugLibConOut.msa</Filename>
|
|
||||||
<Filename>Library/EdkUefiDebugLibStdErr/EdkUefiDebugLibStdErr.msa</Filename>
|
|
||||||
<Filename>Library/EdkUsbLib/EdkUsbLib.msa</Filename>
|
<Filename>Library/EdkUsbLib/EdkUsbLib.msa</Filename>
|
||||||
<Filename>Library/EdkSerialPortLibNull/EdkSerialPortLibNull.msa</Filename>
|
<Filename>Library/EdkSerialPortLibNull/EdkSerialPortLibNull.msa</Filename>
|
||||||
<Filename>Library/EdkOemHookStatusCodeLibNull/EdkOemHookStatusCodeLibNull.msa</Filename>
|
<Filename>Library/EdkOemHookStatusCodeLibNull/EdkOemHookStatusCodeLibNull.msa</Filename>
|
||||||
|
|||||||
@ -1,336 +0,0 @@
|
|||||||
/** @file
|
|
||||||
EFI Debug Library that installs Debug Level Protocol.
|
|
||||||
|
|
||||||
Copyright (c) 2006, 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.
|
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
||||||
STATIC BOOLEAN mDebugLevelInstalled = FALSE;
|
|
||||||
STATIC EFI_DEBUG_LEVEL_PROTOCOL mDebugLevel = { 0 };
|
|
||||||
|
|
||||||
/**
|
|
||||||
Installs Debug Level Protocol.
|
|
||||||
|
|
||||||
The constructor function installs Debug Level Protocol on the ImageHandle.
|
|
||||||
It will ASSERT() if the installation fails and will always return EFI_SUCCESS.
|
|
||||||
|
|
||||||
@param ImageHandle The firmware allocated handle for the EFI image.
|
|
||||||
@param SystemTable A pointer to the EFI System Table.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
DebugLibConstructor (
|
|
||||||
IN EFI_HANDLE ImageHandle,
|
|
||||||
IN EFI_SYSTEM_TABLE *SystemTable
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_STATUS Status;
|
|
||||||
|
|
||||||
//
|
|
||||||
// Initialize Debug Level Protocol.
|
|
||||||
//
|
|
||||||
mDebugLevel.DebugLevel = PcdGet32(PcdDebugPrintErrorLevel);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Install Debug Level Protocol.
|
|
||||||
//
|
|
||||||
Status = gBS->InstallMultipleProtocolInterfaces (
|
|
||||||
&ImageHandle,
|
|
||||||
&gEfiDebugLevelProtocolGuid,
|
|
||||||
&mDebugLevel,
|
|
||||||
NULL
|
|
||||||
);
|
|
||||||
ASSERT_EFI_ERROR (Status);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Set flag to show that the Debug Level Protocol has been installed.
|
|
||||||
//
|
|
||||||
mDebugLevelInstalled = TRUE;
|
|
||||||
|
|
||||||
return Status;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Prints a debug message to the debug output device if the specified error level is enabled.
|
|
||||||
|
|
||||||
If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
|
|
||||||
the message specified by Format and the associated variable argument list to
|
|
||||||
the debug output device.
|
|
||||||
|
|
||||||
If Format is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param ErrorLevel The error level of the debug message.
|
|
||||||
@param Format Format string for the debug message to print.
|
|
||||||
|
|
||||||
**/
|
|
||||||
VOID
|
|
||||||
EFIAPI
|
|
||||||
DebugPrint (
|
|
||||||
IN UINTN ErrorLevel,
|
|
||||||
IN CONST CHAR8 *Format,
|
|
||||||
...
|
|
||||||
)
|
|
||||||
{
|
|
||||||
UINT64 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof (UINT64)];
|
|
||||||
EFI_DEBUG_INFO *DebugInfo;
|
|
||||||
UINTN TotalSize;
|
|
||||||
UINTN Index;
|
|
||||||
VA_LIST Marker;
|
|
||||||
UINT64 *ArgumentPointer;
|
|
||||||
|
|
||||||
//
|
|
||||||
// If Format is NULL, then ASSERT().
|
|
||||||
//
|
|
||||||
ASSERT (Format != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Check driver Debug Level value and global debug level
|
|
||||||
//
|
|
||||||
if (mDebugLevelInstalled) {
|
|
||||||
if ((ErrorLevel & mDebugLevel.DebugLevel) == 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
TotalSize = sizeof (EFI_DEBUG_INFO) + 12 * sizeof (UINT64) + AsciiStrLen (Format) + 1;
|
|
||||||
if (TotalSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Then EFI_DEBUG_INFO
|
|
||||||
//
|
|
||||||
DebugInfo = (EFI_DEBUG_INFO *)Buffer;
|
|
||||||
DebugInfo->ErrorLevel = (UINT32)ErrorLevel;
|
|
||||||
|
|
||||||
//
|
|
||||||
// 256 byte mini Var Arg stack. That is followed by the format string.
|
|
||||||
//
|
|
||||||
VA_START (Marker, Format);
|
|
||||||
for (Index = 0, ArgumentPointer = (UINT64 *)(DebugInfo + 1); Index < 12; Index++, ArgumentPointer++) {
|
|
||||||
WriteUnaligned64(ArgumentPointer, VA_ARG (Marker, UINT64));
|
|
||||||
}
|
|
||||||
VA_END (Marker);
|
|
||||||
AsciiStrCpy ((CHAR8 *)ArgumentPointer, Format);
|
|
||||||
|
|
||||||
REPORT_STATUS_CODE_EX (
|
|
||||||
EFI_DEBUG_CODE,
|
|
||||||
(EFI_SOFTWARE_DXE_BS_DRIVER | EFI_DC_UNSPECIFIED),
|
|
||||||
0,
|
|
||||||
NULL,
|
|
||||||
&gEfiStatusCodeDataTypeDebugGuid,
|
|
||||||
DebugInfo,
|
|
||||||
TotalSize
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Prints an assert message containing a filename, line number, and description.
|
|
||||||
This may be followed by a breakpoint or a dead loop.
|
|
||||||
|
|
||||||
Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
|
|
||||||
to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
|
|
||||||
DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
|
|
||||||
CpuDeadLoop() is called. If neither of these bits are set, then this function
|
|
||||||
returns immediately after the message is printed to the debug output device.
|
|
||||||
DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
|
|
||||||
processing another DebugAssert(), then DebugAssert() must return immediately.
|
|
||||||
|
|
||||||
If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
|
|
||||||
|
|
||||||
If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
|
|
||||||
|
|
||||||
@param FileName Pointer to the name of the source file that generated the assert condition.
|
|
||||||
@param LineNumber The line number in the source file that generated the assert condition
|
|
||||||
@param Description Pointer to the description of the assert condition.
|
|
||||||
|
|
||||||
**/
|
|
||||||
VOID
|
|
||||||
EFIAPI
|
|
||||||
DebugAssert (
|
|
||||||
IN CONST CHAR8 *FileName,
|
|
||||||
IN UINTN LineNumber,
|
|
||||||
IN CONST CHAR8 *Description
|
|
||||||
)
|
|
||||||
{
|
|
||||||
UINT64 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof(UINT64)];
|
|
||||||
EFI_DEBUG_ASSERT_DATA *AssertData;
|
|
||||||
UINTN TotalSize;
|
|
||||||
CHAR8 *Temp;
|
|
||||||
|
|
||||||
//
|
|
||||||
// Make sure it will all fit in the passed in buffer.
|
|
||||||
//
|
|
||||||
TotalSize = sizeof (EFI_DEBUG_ASSERT_DATA) + AsciiStrLen (FileName) + 1 + AsciiStrLen (Description) + 1;
|
|
||||||
if (TotalSize <= EFI_STATUS_CODE_DATA_MAX_SIZE) {
|
|
||||||
//
|
|
||||||
// Fill in EFI_DEBUG_ASSERT_DATA
|
|
||||||
//
|
|
||||||
AssertData = (EFI_DEBUG_ASSERT_DATA *)Buffer;
|
|
||||||
AssertData->LineNumber = (UINT32)LineNumber;
|
|
||||||
|
|
||||||
//
|
|
||||||
// Copy Ascii FileName including NULL.
|
|
||||||
//
|
|
||||||
Temp = AsciiStrCpy ((CHAR8 *)(AssertData + 1), FileName);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Copy Ascii Description.
|
|
||||||
//
|
|
||||||
AsciiStrCpy (Temp + AsciiStrLen (FileName) + 1, Description);
|
|
||||||
|
|
||||||
REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
|
|
||||||
(EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),
|
|
||||||
(EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),
|
|
||||||
AssertData,
|
|
||||||
TotalSize
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
|
|
||||||
//
|
|
||||||
if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
|
|
||||||
CpuBreakpoint ();
|
|
||||||
} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
|
|
||||||
CpuDeadLoop ();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
|
|
||||||
|
|
||||||
This function fills Length bytes of Buffer with the value specified by
|
|
||||||
PcdDebugClearMemoryValue, and returns Buffer.
|
|
||||||
|
|
||||||
If Buffer is NULL, then ASSERT().
|
|
||||||
|
|
||||||
If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
|
|
||||||
|
|
||||||
@param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
|
|
||||||
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
|
|
||||||
|
|
||||||
@return Buffer
|
|
||||||
|
|
||||||
**/
|
|
||||||
VOID *
|
|
||||||
EFIAPI
|
|
||||||
DebugClearMemory (
|
|
||||||
OUT VOID *Buffer,
|
|
||||||
IN UINTN Length
|
|
||||||
)
|
|
||||||
{
|
|
||||||
//
|
|
||||||
// If Buffer is NULL, then ASSERT().
|
|
||||||
//
|
|
||||||
ASSERT (Buffer != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// SetMem() checks for the the ASSERT() condition on Length and returns Buffer
|
|
||||||
//
|
|
||||||
return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if ASSERT() macros are enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugAssertEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if DEBUG()macros are enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugPrintEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if DEBUG_CODE()macros are enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugCodeEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugClearMemoryEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
@ -1,89 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
|
||||||
<MsaHeader>
|
|
||||||
<ModuleName>EdkDxeDebugLibReportStatusCode</ModuleName>
|
|
||||||
<ModuleType>DXE_DRIVER</ModuleType>
|
|
||||||
<GuidValue>76a2a4d8-f605-407a-8057-4a17dcdc4c6d</GuidValue>
|
|
||||||
<Version>1.0</Version>
|
|
||||||
<Abstract>Debug Library for DXE drivers</Abstract>
|
|
||||||
<Description>This library provides debug functions by laying on a Report Status Code Library.</Description>
|
|
||||||
<Copyright>Copyright (c) 2006, Intel Corporation.</Copyright>
|
|
||||||
<License>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.</License>
|
|
||||||
<Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052</Specification>
|
|
||||||
</MsaHeader>
|
|
||||||
<ModuleDefinitions>
|
|
||||||
<SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>
|
|
||||||
<BinaryModule>false</BinaryModule>
|
|
||||||
<OutputFileBasename>EdkDxeDebugLibReportStatusCode</OutputFileBasename>
|
|
||||||
</ModuleDefinitions>
|
|
||||||
<LibraryClassDefinitions>
|
|
||||||
<LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER">
|
|
||||||
<Keyword>DebugLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>ReportStatusCodeLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>BaseMemoryLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>BaseLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>PcdLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>UefiBootServicesTableLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
</LibraryClassDefinitions>
|
|
||||||
<SourceFiles>
|
|
||||||
<Filename>DebugLib.c</Filename>
|
|
||||||
</SourceFiles>
|
|
||||||
<PackageDependencies>
|
|
||||||
<Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>
|
|
||||||
<Package PackageGuid="68169ab0-d41b-4009-9060-292c253ac43d"/>
|
|
||||||
</PackageDependencies>
|
|
||||||
<Protocols>
|
|
||||||
<Protocol Usage="ALWAYS_PRODUCED">
|
|
||||||
<ProtocolCName>gEfiDebugLevelProtocolGuid</ProtocolCName>
|
|
||||||
</Protocol>
|
|
||||||
</Protocols>
|
|
||||||
<Guids>
|
|
||||||
<GuidCNames Usage="ALWAYS_CONSUMED">
|
|
||||||
<GuidCName>gEfiStatusCodeDataTypeDebugGuid</GuidCName>
|
|
||||||
</GuidCNames>
|
|
||||||
</Guids>
|
|
||||||
<Externs>
|
|
||||||
<Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>
|
|
||||||
<Specification>EDK_RELEASE_VERSION 0x00020000</Specification>
|
|
||||||
<Extern>
|
|
||||||
<Constructor>DebugLibConstructor</Constructor>
|
|
||||||
</Extern>
|
|
||||||
</Externs>
|
|
||||||
<PcdCoded>
|
|
||||||
<PcdEntry PcdItemType="FIXED_AT_BUILD">
|
|
||||||
<C_Name>PcdDebugPropertyMask</C_Name>
|
|
||||||
<TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
|
|
||||||
<HelpText>The bitmask of flags that specify the enable/disable of Debug
|
|
||||||
Assert, Debug Print, Debug Code, Clear Memory, Assert
|
|
||||||
Breakpoint and Assert Deadloop.</HelpText>
|
|
||||||
</PcdEntry>
|
|
||||||
<PcdEntry PcdItemType="FIXED_AT_BUILD">
|
|
||||||
<C_Name>PcdDebugClearMemoryValue</C_Name>
|
|
||||||
<TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
|
|
||||||
<HelpText>The value used by DebugClearMemory () to fill a certain range
|
|
||||||
of memory.</HelpText>
|
|
||||||
</PcdEntry>
|
|
||||||
<PcdEntry PcdItemType="DYNAMIC">
|
|
||||||
<C_Name>PcdDebugPrintErrorLevel</C_Name>
|
|
||||||
<TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
|
|
||||||
<HelpText>The bitmask of flags that specify the kind of debug message
|
|
||||||
output when Debug Print is enabled.</HelpText>
|
|
||||||
</PcdEntry>
|
|
||||||
</PcdCoded>
|
|
||||||
</ModuleSurfaceArea>
|
|
||||||
@ -1,300 +0,0 @@
|
|||||||
/** @file
|
|
||||||
UEFI Debug Library that uses PrintLib to send messages to CONOUT.
|
|
||||||
|
|
||||||
Copyright (c) 2006, 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.
|
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
||||||
//
|
|
||||||
// Define the maximum debug and assert message length that this library supports.
|
|
||||||
//
|
|
||||||
#define MAX_DEBUG_MESSAGE_LENGTH 0x100
|
|
||||||
|
|
||||||
STATIC BOOLEAN mDebugLevelInstalled = FALSE;
|
|
||||||
STATIC EFI_DEBUG_LEVEL_PROTOCOL mDebugLevel = { 0 };
|
|
||||||
|
|
||||||
/**
|
|
||||||
Installs Debug Level Protocol.
|
|
||||||
|
|
||||||
The constructor function installs Debug Level Protocol on the ImageHandle.
|
|
||||||
It will ASSERT() if the installation fails and will always return EFI_SUCCESS.
|
|
||||||
|
|
||||||
@param ImageHandle The firmware allocated handle for the EFI image.
|
|
||||||
@param SystemTable A pointer to the EFI System Table.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
DebugLibConstructor (
|
|
||||||
IN EFI_HANDLE ImageHandle,
|
|
||||||
IN EFI_SYSTEM_TABLE *SystemTable
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_STATUS Status;
|
|
||||||
|
|
||||||
//
|
|
||||||
// Initialize Debug Level Protocol.
|
|
||||||
//
|
|
||||||
mDebugLevel.DebugLevel = PcdGet32(PcdDebugPrintErrorLevel);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Install Debug Level Protocol.
|
|
||||||
//
|
|
||||||
Status = gBS->InstallMultipleProtocolInterfaces (
|
|
||||||
&ImageHandle,
|
|
||||||
&gEfiDebugLevelProtocolGuid,
|
|
||||||
&mDebugLevel,
|
|
||||||
NULL
|
|
||||||
);
|
|
||||||
ASSERT_EFI_ERROR (Status);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Set flag to show that the Debug Level Protocol has been installed.
|
|
||||||
//
|
|
||||||
mDebugLevelInstalled = TRUE;
|
|
||||||
|
|
||||||
return Status;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Prints a debug message to the debug output device if the specified error level is enabled.
|
|
||||||
|
|
||||||
If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
|
|
||||||
the message specified by Format and the associated variable argument list to
|
|
||||||
the debug output device.
|
|
||||||
|
|
||||||
If Format is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param ErrorLevel The error level of the debug message.
|
|
||||||
@param Format Format string for the debug message to print.
|
|
||||||
|
|
||||||
**/
|
|
||||||
VOID
|
|
||||||
EFIAPI
|
|
||||||
DebugPrint (
|
|
||||||
IN UINTN ErrorLevel,
|
|
||||||
IN CONST CHAR8 *Format,
|
|
||||||
...
|
|
||||||
)
|
|
||||||
{
|
|
||||||
CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
|
|
||||||
VA_LIST Marker;
|
|
||||||
|
|
||||||
//
|
|
||||||
// If Format is NULL, then ASSERT().
|
|
||||||
//
|
|
||||||
ASSERT (Format != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Check driver Debug Level value and global debug level
|
|
||||||
//
|
|
||||||
if (mDebugLevelInstalled) {
|
|
||||||
if ((ErrorLevel & mDebugLevel.DebugLevel) == 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Convert the DEBUG() message to a Unicode String
|
|
||||||
//
|
|
||||||
VA_START (Marker, Format);
|
|
||||||
UnicodeVSPrintAsciiFormat (Buffer, sizeof (Buffer), Format, Marker);
|
|
||||||
VA_END (Marker);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Send the print string to the Console Output device if CONOUT is available.
|
|
||||||
//
|
|
||||||
if (gST->ConOut != NULL) {
|
|
||||||
gST->ConOut->OutputString (gST->ConOut, Buffer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Prints an assert message containing a filename, line number, and description.
|
|
||||||
This may be followed by a breakpoint or a dead loop.
|
|
||||||
|
|
||||||
Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
|
|
||||||
to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
|
|
||||||
DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
|
|
||||||
CpuDeadLoop() is called. If neither of these bits are set, then this function
|
|
||||||
returns immediately after the message is printed to the debug output device.
|
|
||||||
DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
|
|
||||||
processing another DebugAssert(), then DebugAssert() must return immediately.
|
|
||||||
|
|
||||||
If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
|
|
||||||
|
|
||||||
If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
|
|
||||||
|
|
||||||
@param FileName Pointer to the name of the source file that generated the assert condition.
|
|
||||||
@param LineNumber The line number in the source file that generated the assert condition
|
|
||||||
@param Description Pointer to the description of the assert condition.
|
|
||||||
|
|
||||||
**/
|
|
||||||
VOID
|
|
||||||
EFIAPI
|
|
||||||
DebugAssert (
|
|
||||||
IN CONST CHAR8 *FileName,
|
|
||||||
IN UINTN LineNumber,
|
|
||||||
IN CONST CHAR8 *Description
|
|
||||||
)
|
|
||||||
{
|
|
||||||
CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
|
|
||||||
|
|
||||||
//
|
|
||||||
// Generate the ASSERT() message in Unicode format
|
|
||||||
//
|
|
||||||
UnicodeSPrintAsciiFormat (Buffer, sizeof (Buffer), "ASSERT %s(%d): %s\n", FileName, LineNumber, Description);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Send the print string to the Console Output device if CONOUT is available.
|
|
||||||
//
|
|
||||||
if (gST->ConOut != NULL) {
|
|
||||||
gST->ConOut->OutputString (gST->ConOut, Buffer);
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
|
|
||||||
//
|
|
||||||
if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
|
|
||||||
CpuBreakpoint ();
|
|
||||||
} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
|
|
||||||
CpuDeadLoop ();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
|
|
||||||
|
|
||||||
This function fills Length bytes of Buffer with the value specified by
|
|
||||||
PcdDebugClearMemoryValue, and returns Buffer.
|
|
||||||
|
|
||||||
If Buffer is NULL, then ASSERT().
|
|
||||||
|
|
||||||
If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
|
|
||||||
|
|
||||||
@param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
|
|
||||||
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
|
|
||||||
|
|
||||||
@return Buffer
|
|
||||||
|
|
||||||
**/
|
|
||||||
VOID *
|
|
||||||
EFIAPI
|
|
||||||
DebugClearMemory (
|
|
||||||
OUT VOID *Buffer,
|
|
||||||
IN UINTN Length
|
|
||||||
)
|
|
||||||
{
|
|
||||||
//
|
|
||||||
// If Buffer is NULL, then ASSERT().
|
|
||||||
//
|
|
||||||
ASSERT (Buffer != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// SetMem() checks for the the ASSERT() condition on Length and returns Buffer
|
|
||||||
//
|
|
||||||
return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if ASSERT() macros are enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugAssertEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if DEBUG()macros are enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugPrintEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if DEBUG_CODE()macros are enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugCodeEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugClearMemoryEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
@ -1,84 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
|
||||||
<MsaHeader>
|
|
||||||
<ModuleName>EdkUefiDebugLibConOut</ModuleName>
|
|
||||||
<ModuleType>DXE_DRIVER</ModuleType>
|
|
||||||
<GuidValue>7293fe0b-1fff-4f8f-b808-10cb55f6a174</GuidValue>
|
|
||||||
<Version>1.0</Version>
|
|
||||||
<Abstract>Debug Library for UEFI drivers</Abstract>
|
|
||||||
<Description>This library uses PrintLib to send messages to CONOUT.</Description>
|
|
||||||
<Copyright>Copyright (c) 2006 - 2007, Intel Corporation.</Copyright>
|
|
||||||
<License>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.</License>
|
|
||||||
<Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052</Specification>
|
|
||||||
</MsaHeader>
|
|
||||||
<ModuleDefinitions>
|
|
||||||
<SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>
|
|
||||||
<BinaryModule>false</BinaryModule>
|
|
||||||
<OutputFileBasename>EdkUefiDebugLibConOut</OutputFileBasename>
|
|
||||||
</ModuleDefinitions>
|
|
||||||
<LibraryClassDefinitions>
|
|
||||||
<LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER">
|
|
||||||
<Keyword>DebugLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>PrintLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>PcdLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>UefiBootServicesTableLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>BaseMemoryLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>BaseLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
</LibraryClassDefinitions>
|
|
||||||
<SourceFiles>
|
|
||||||
<Filename>DebugLib.c</Filename>
|
|
||||||
</SourceFiles>
|
|
||||||
<PackageDependencies>
|
|
||||||
<Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>
|
|
||||||
<Package PackageGuid="68169ab0-d41b-4009-9060-292c253ac43d"/>
|
|
||||||
</PackageDependencies>
|
|
||||||
<Protocols>
|
|
||||||
<Protocol Usage="ALWAYS_PRODUCED">
|
|
||||||
<ProtocolCName>gEfiDebugLevelProtocolGuid</ProtocolCName>
|
|
||||||
</Protocol>
|
|
||||||
</Protocols>
|
|
||||||
<Externs>
|
|
||||||
<Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>
|
|
||||||
<Specification>EDK_RELEASE_VERSION 0x00020000</Specification>
|
|
||||||
<Extern>
|
|
||||||
<Constructor>DebugLibConstructor</Constructor>
|
|
||||||
</Extern>
|
|
||||||
</Externs>
|
|
||||||
<PcdCoded>
|
|
||||||
<PcdEntry PcdItemType="FIXED_AT_BUILD">
|
|
||||||
<C_Name>PcdDebugPropertyMask</C_Name>
|
|
||||||
<TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
|
|
||||||
<HelpText>The bitmask of flags that specify the enable/disable of Debug
|
|
||||||
Assert, Debug Print, Debug Code, Clear Memory, Assert
|
|
||||||
Breakpoint and Assert Deadloop.</HelpText>
|
|
||||||
</PcdEntry>
|
|
||||||
<PcdEntry PcdItemType="DYNAMIC">
|
|
||||||
<C_Name>PcdDebugPrintErrorLevel</C_Name>
|
|
||||||
<TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
|
|
||||||
<HelpText>The bitmask of flags that specify the kind of debug message
|
|
||||||
output when Debug Print is enabled.</HelpText>
|
|
||||||
</PcdEntry>
|
|
||||||
<PcdEntry PcdItemType="FIXED_AT_BUILD">
|
|
||||||
<C_Name>PcdDebugClearMemoryValue</C_Name>
|
|
||||||
<TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
|
|
||||||
<HelpText>The value used by DebugClearMemory () to fill a certain range
|
|
||||||
of memory.</HelpText>
|
|
||||||
</PcdEntry>
|
|
||||||
</PcdCoded>
|
|
||||||
</ModuleSurfaceArea>
|
|
||||||
@ -1,300 +0,0 @@
|
|||||||
/** @file
|
|
||||||
UEFI Debug Library that uses PrintLib to send messages to STDERR.
|
|
||||||
|
|
||||||
Copyright (c) 2006, 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.
|
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
||||||
//
|
|
||||||
// Define the maximum debug and assert message length that this library supports.
|
|
||||||
//
|
|
||||||
#define MAX_DEBUG_MESSAGE_LENGTH 0x100
|
|
||||||
|
|
||||||
STATIC BOOLEAN mDebugLevelInstalled = FALSE;
|
|
||||||
STATIC EFI_DEBUG_LEVEL_PROTOCOL mDebugLevel = { 0 };
|
|
||||||
|
|
||||||
/**
|
|
||||||
Installs Debug Level Protocol.
|
|
||||||
|
|
||||||
The constructor function installs Debug Level Protocol on the ImageHandle.
|
|
||||||
It will ASSERT() if the installation fails and will always return EFI_SUCCESS.
|
|
||||||
|
|
||||||
@param ImageHandle The firmware allocated handle for the EFI image.
|
|
||||||
@param SystemTable A pointer to the EFI System Table.
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
|
|
||||||
|
|
||||||
**/
|
|
||||||
EFI_STATUS
|
|
||||||
EFIAPI
|
|
||||||
DebugLibConstructor (
|
|
||||||
IN EFI_HANDLE ImageHandle,
|
|
||||||
IN EFI_SYSTEM_TABLE *SystemTable
|
|
||||||
)
|
|
||||||
{
|
|
||||||
EFI_STATUS Status;
|
|
||||||
|
|
||||||
//
|
|
||||||
// Initialize Debug Level Protocol.
|
|
||||||
//
|
|
||||||
mDebugLevel.DebugLevel = PcdGet32(PcdDebugPrintErrorLevel);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Install Debug Level Protocol.
|
|
||||||
//
|
|
||||||
Status = gBS->InstallMultipleProtocolInterfaces (
|
|
||||||
&ImageHandle,
|
|
||||||
&gEfiDebugLevelProtocolGuid,
|
|
||||||
&mDebugLevel,
|
|
||||||
NULL
|
|
||||||
);
|
|
||||||
ASSERT_EFI_ERROR (Status);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Set flag to show that the Debug Level Protocol has been installed.
|
|
||||||
//
|
|
||||||
mDebugLevelInstalled = TRUE;
|
|
||||||
|
|
||||||
return Status;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Prints a debug message to the debug output device if the specified error level is enabled.
|
|
||||||
|
|
||||||
If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
|
|
||||||
the message specified by Format and the associated variable argument list to
|
|
||||||
the debug output device.
|
|
||||||
|
|
||||||
If Format is NULL, then ASSERT().
|
|
||||||
|
|
||||||
@param ErrorLevel The error level of the debug message.
|
|
||||||
@param Format Format string for the debug message to print.
|
|
||||||
|
|
||||||
**/
|
|
||||||
VOID
|
|
||||||
EFIAPI
|
|
||||||
DebugPrint (
|
|
||||||
IN UINTN ErrorLevel,
|
|
||||||
IN CONST CHAR8 *Format,
|
|
||||||
...
|
|
||||||
)
|
|
||||||
{
|
|
||||||
CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
|
|
||||||
VA_LIST Marker;
|
|
||||||
|
|
||||||
//
|
|
||||||
// If Format is NULL, then ASSERT().
|
|
||||||
//
|
|
||||||
ASSERT (Format != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Check driver Debug Level value and global debug level
|
|
||||||
//
|
|
||||||
if (mDebugLevelInstalled) {
|
|
||||||
if ((ErrorLevel & mDebugLevel.DebugLevel) == 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Convert the DEBUG() message to a Unicode String
|
|
||||||
//
|
|
||||||
VA_START (Marker, Format);
|
|
||||||
UnicodeVSPrintAsciiFormat (Buffer, sizeof (Buffer), Format, Marker);
|
|
||||||
VA_END (Marker);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Send the print string to the Standard Error device if STDERR is available.
|
|
||||||
//
|
|
||||||
if (gST->StdErr != NULL) {
|
|
||||||
gST->StdErr->OutputString (gST->StdErr, Buffer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Prints an assert message containing a filename, line number, and description.
|
|
||||||
This may be followed by a breakpoint or a dead loop.
|
|
||||||
|
|
||||||
Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
|
|
||||||
to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
|
|
||||||
DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
|
|
||||||
CpuDeadLoop() is called. If neither of these bits are set, then this function
|
|
||||||
returns immediately after the message is printed to the debug output device.
|
|
||||||
DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
|
|
||||||
processing another DebugAssert(), then DebugAssert() must return immediately.
|
|
||||||
|
|
||||||
If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
|
|
||||||
|
|
||||||
If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
|
|
||||||
|
|
||||||
@param FileName Pointer to the name of the source file that generated the assert condition.
|
|
||||||
@param LineNumber The line number in the source file that generated the assert condition
|
|
||||||
@param Description Pointer to the description of the assert condition.
|
|
||||||
|
|
||||||
**/
|
|
||||||
VOID
|
|
||||||
EFIAPI
|
|
||||||
DebugAssert (
|
|
||||||
IN CONST CHAR8 *FileName,
|
|
||||||
IN UINTN LineNumber,
|
|
||||||
IN CONST CHAR8 *Description
|
|
||||||
)
|
|
||||||
{
|
|
||||||
CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
|
|
||||||
|
|
||||||
//
|
|
||||||
// Generate the ASSERT() message in Unicode format
|
|
||||||
//
|
|
||||||
UnicodeSPrintAsciiFormat (Buffer, sizeof (Buffer), "ASSERT %s(%d): %s\n", FileName, LineNumber, Description);
|
|
||||||
|
|
||||||
//
|
|
||||||
// Send the print string to the Standard Error device if STDERR is available.
|
|
||||||
//
|
|
||||||
if (gST->StdErr != NULL) {
|
|
||||||
gST->StdErr->OutputString (gST->StdErr, Buffer);
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
|
|
||||||
//
|
|
||||||
if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
|
|
||||||
CpuBreakpoint ();
|
|
||||||
} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
|
|
||||||
CpuDeadLoop ();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
|
|
||||||
|
|
||||||
This function fills Length bytes of Buffer with the value specified by
|
|
||||||
PcdDebugClearMemoryValue, and returns Buffer.
|
|
||||||
|
|
||||||
If Buffer is NULL, then ASSERT().
|
|
||||||
|
|
||||||
If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
|
|
||||||
|
|
||||||
@param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
|
|
||||||
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
|
|
||||||
|
|
||||||
@return Buffer
|
|
||||||
|
|
||||||
**/
|
|
||||||
VOID *
|
|
||||||
EFIAPI
|
|
||||||
DebugClearMemory (
|
|
||||||
OUT VOID *Buffer,
|
|
||||||
IN UINTN Length
|
|
||||||
)
|
|
||||||
{
|
|
||||||
//
|
|
||||||
// If Buffer is NULL, then ASSERT().
|
|
||||||
//
|
|
||||||
ASSERT (Buffer != NULL);
|
|
||||||
|
|
||||||
//
|
|
||||||
// SetMem() checks for the the ASSERT() condition on Length and returns Buffer
|
|
||||||
//
|
|
||||||
return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if ASSERT() macros are enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugAssertEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if DEBUG()macros are enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugPrintEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if DEBUG_CODE()macros are enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugCodeEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
|
|
||||||
Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
|
|
||||||
|
|
||||||
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
|
|
||||||
PcdDebugProperyMask is set. Otherwise FALSE is returned.
|
|
||||||
|
|
||||||
@retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
|
|
||||||
@retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
|
|
||||||
|
|
||||||
**/
|
|
||||||
BOOLEAN
|
|
||||||
EFIAPI
|
|
||||||
DebugClearMemoryEnabled (
|
|
||||||
VOID
|
|
||||||
)
|
|
||||||
{
|
|
||||||
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
|
|
||||||
}
|
|
||||||
@ -1,84 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
|
||||||
<MsaHeader>
|
|
||||||
<ModuleName>EdkUefiDebugLibStdErr</ModuleName>
|
|
||||||
<ModuleType>DXE_DRIVER</ModuleType>
|
|
||||||
<GuidValue>8b9968e0-c76b-4b57-aec4-24e17fe602c0</GuidValue>
|
|
||||||
<Version>1.0</Version>
|
|
||||||
<Abstract>Debug Library for UEFI drivers</Abstract>
|
|
||||||
<Description>This library uses PrintLib to send messages to STDERR.</Description>
|
|
||||||
<Copyright>Copyright (c) 2006 - 2007, Intel Corporation.</Copyright>
|
|
||||||
<License>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.</License>
|
|
||||||
<Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052</Specification>
|
|
||||||
</MsaHeader>
|
|
||||||
<ModuleDefinitions>
|
|
||||||
<SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>
|
|
||||||
<BinaryModule>false</BinaryModule>
|
|
||||||
<OutputFileBasename>EdkUefiDebugLibConOut</OutputFileBasename>
|
|
||||||
</ModuleDefinitions>
|
|
||||||
<LibraryClassDefinitions>
|
|
||||||
<LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER">
|
|
||||||
<Keyword>DebugLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>PrintLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>PcdLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>UefiBootServicesTableLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>BaseMemoryLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
<LibraryClass Usage="ALWAYS_CONSUMED">
|
|
||||||
<Keyword>BaseLib</Keyword>
|
|
||||||
</LibraryClass>
|
|
||||||
</LibraryClassDefinitions>
|
|
||||||
<SourceFiles>
|
|
||||||
<Filename>DebugLib.c</Filename>
|
|
||||||
</SourceFiles>
|
|
||||||
<PackageDependencies>
|
|
||||||
<Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>
|
|
||||||
<Package PackageGuid="68169ab0-d41b-4009-9060-292c253ac43d"/>
|
|
||||||
</PackageDependencies>
|
|
||||||
<Protocols>
|
|
||||||
<Protocol Usage="ALWAYS_PRODUCED">
|
|
||||||
<ProtocolCName>gEfiDebugLevelProtocolGuid</ProtocolCName>
|
|
||||||
</Protocol>
|
|
||||||
</Protocols>
|
|
||||||
<Externs>
|
|
||||||
<Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>
|
|
||||||
<Specification>EDK_RELEASE_VERSION 0x00020000</Specification>
|
|
||||||
<Extern>
|
|
||||||
<Constructor>DebugLibConstructor</Constructor>
|
|
||||||
</Extern>
|
|
||||||
</Externs>
|
|
||||||
<PcdCoded>
|
|
||||||
<PcdEntry PcdItemType="FIXED_AT_BUILD">
|
|
||||||
<C_Name>PcdDebugPropertyMask</C_Name>
|
|
||||||
<TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
|
|
||||||
<HelpText>The bitmask of flags that specify the enable/disable of Debug
|
|
||||||
Assert, Debug Print, Debug Code, Clear Memory, Assert
|
|
||||||
Breakpoint and Assert Deadloop.</HelpText>
|
|
||||||
</PcdEntry>
|
|
||||||
<PcdEntry PcdItemType="DYNAMIC">
|
|
||||||
<C_Name>PcdDebugPrintErrorLevel</C_Name>
|
|
||||||
<TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
|
|
||||||
<HelpText>The bitmask of flags that specify the kind of debug message
|
|
||||||
output when Debug Print is enabled.</HelpText>
|
|
||||||
</PcdEntry>
|
|
||||||
<PcdEntry PcdItemType="FIXED_AT_BUILD">
|
|
||||||
<C_Name>PcdDebugClearMemoryValue</C_Name>
|
|
||||||
<TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>
|
|
||||||
<HelpText>The value used by DebugClearMemory () to fill a certain range
|
|
||||||
of memory.</HelpText>
|
|
||||||
</PcdEntry>
|
|
||||||
</PcdCoded>
|
|
||||||
</ModuleSurfaceArea>
|
|
||||||
Loading…
x
Reference in New Issue
Block a user