#include <Framework/DataHubRecords.h>\r
#include <Protocol/DebugSupport.h>\r
\r
-///\r
-/// The size of string\r
-///\r
-#define EFI_STATUS_CODE_DATA_MAX_STRING_SIZE 150\r
-\r
///\r
/// This is the max data size including all the headers which can be passed\r
/// as Status Code data. This data should be multiple of 8 byte\r
\r
#pragma pack()\r
\r
-#pragma pack(1)\r
-\r
-typedef struct {\r
- UINT32 ErrorLevel;\r
- //\r
- // 12 * sizeof (UINT64) Var Arg stack\r
- //\r
- // ascii DEBUG () Format string\r
- //\r
-} EFI_DEBUG_INFO;\r
-\r
-#pragma pack()\r
-\r
//\r
// declaration for EFI_EXP_DATA. This may change\r
//\r
#\r
################################################################################\r
[Components.common]\r
- IntelFrameworkPkg/Library/BaseReportStatusCodeLib/BaseReportStatusCodeLib.inf\r
- IntelFrameworkPkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf\r
IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf\r
IntelFrameworkPkg/Library/UefiLibFramework/UefiLibFramework.inf\r
IntelFrameworkPkg/Library/DxeSmmDriverEntryPoint/DxeSmmDriverEntryPoint.inf\r
IntelFrameworkPkg/Library/HiiLibFramework/HiiLib.inf\r
- IntelFrameworkPkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf\r
IntelFrameworkPkg/Library/IfrSupportLibFramework/IfrSupportLib.inf\r
IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLibSmbusPpi.inf\r
+++ /dev/null
-/** @file\r
- Report Status Code Library for DXE Phase.\r
-\r
- Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-**/\r
-\r
-\r
-#include <Base.h>\r
-#include <Framework/StatusCodeDataTypeId.h>\r
-#include <Framework/StatusCode.h>\r
-\r
-#include <Guid/StatusCodeDataTypeId.h>\r
-#include <Library/ReportStatusCodeLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/BaseLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/PcdLib.h>\r
-\r
-\r
-\r
-/**\r
- Internal worker function that reports a status code through the Status Code Protocol\r
-\r
- This function checks to see if a Status Code Protocol is present in the handle\r
- database. If a Status Code Protocol is not present, then EFI_UNSUPPORTED is\r
- returned. If a Status Code Protocol is present, then it is cached in gStatusCode,\r
- and the ReportStatusCode() service of the Status Code Protocol is called passing in\r
- Type, Value, Instance, CallerId, and Data. The result of this call is returned.\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this\r
- function. This is an optional parameter that may be\r
- NULL.\r
- @param Data Pointer to the extended data buffer. This is an\r
- optional parameter that may be NULL.\r
-\r
- @retval EFI_SUCCESS The status code was reported.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to report the status code.\r
- @retval EFI_UNSUPPORTED Status Code Protocol is not available.\r
-\r
-**/\r
-STATIC\r
-EFI_STATUS\r
-InternalReportStatusCode (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN UINT32 Instance,\r
- IN CONST EFI_GUID *CallerId OPTIONAL,\r
- IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
- )\r
-{\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Computes and returns the size, in bytes, of a device path.\r
-\r
- @param DevicePath A pointer to a device path.\r
-\r
- @return The size, in bytes, of DevicePath.\r
-\r
-**/\r
-STATIC\r
-UINTN\r
-InternalReportStatusCodeDevicePathSize (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-{\r
- CONST EFI_DEVICE_PATH_PROTOCOL *Start;\r
-\r
- //\r
- // Search for the end of the device path structure\r
- //\r
- Start = DevicePath;\r
- while (!EfiIsDevicePathEnd (DevicePath)) {\r
- DevicePath = EfiNextDevicePathNode (DevicePath);\r
- }\r
-\r
- //\r
- // Subtract the start node from the end node and add in the size of the end node\r
- //\r
- return ((UINTN) DevicePath - (UINTN) Start) + DevicePathNodeLength (DevicePath);\r
-}\r
-\r
-\r
-/**\r
- Converts a status code to an 8-bit POST code value.\r
-\r
- Converts the status code specified by CodeType and Value to an 8-bit POST code\r
- and returns the 8-bit POST code in PostCode. If CodeType is an\r
- EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode\r
- are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits\r
- 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.\r
-\r
- If PostCode is NULL, then ASSERT().\r
-\r
- @param CodeType The type of status code being converted.\r
- @param Value The status code value being converted.\r
- @param PostCode A pointer to the 8-bit POST code value to return.\r
-\r
- @retval TRUE The status code specified by CodeType and Value was converted\r
- to an 8-bit POST code and returned in PostCode.\r
- @retval FALSE The status code specified by CodeType and Value could not be\r
- converted to an 8-bit POST code value.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-CodeTypeToPostCode (\r
- IN EFI_STATUS_CODE_TYPE CodeType,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- OUT UINT8 *PostCode\r
- )\r
-{\r
- //\r
- // If PostCode is NULL, then ASSERT()\r
- //\r
- ASSERT (PostCode != NULL);\r
-\r
- //\r
- // Convert Value to an 8 bit post code\r
- //\r
- if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||\r
- ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) ) {\r
- *PostCode = (UINT8) ((((Value & EFI_STATUS_CODE_CLASS_MASK) >> 24) << 5) |\r
- (((Value & EFI_STATUS_CODE_SUBCLASS_MASK) >> 16) & 0x1f));\r
- return TRUE;\r
- }\r
- return FALSE;\r
-}\r
-\r
-\r
-/**\r
- Extracts ASSERT() information from a status code structure.\r
-\r
- Converts the status code specified by CodeType, Value, and Data to the ASSERT()\r
- arguments specified by Filename, Description, and LineNumber. If CodeType is\r
- an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and\r
- Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract\r
- Filename, Description, and LineNumber from the optional data area of the\r
- status code buffer specified by Data. The optional data area of Data contains\r
- a Null-terminated ASCII string for the FileName, followed by a Null-terminated\r
- ASCII string for the Description, followed by a 32-bit LineNumber. If the\r
- ASSERT() information could be extracted from Data, then return TRUE.\r
- Otherwise, FALSE is returned.\r
-\r
- If Data is NULL, then ASSERT().\r
- If Filename is NULL, then ASSERT().\r
- If Description is NULL, then ASSERT().\r
- If LineNumber is NULL, then ASSERT().\r
-\r
- @param CodeType The type of status code being converted.\r
- @param Value The status code value being converted.\r
- @param Data Pointer to status code data buffer.\r
- @param Filename Pointer to the source file name that generated the ASSERT().\r
- @param Description Pointer to the description of the ASSERT().\r
- @param LineNumber Pointer to source line number that generated the ASSERT().\r
-\r
- @retval TRUE The status code specified by CodeType, Value, and Data was\r
- converted ASSERT() arguments specified by Filename, Description,\r
- and LineNumber.\r
- @retval FALSE The status code specified by CodeType, Value, and Data could\r
- not be converted to ASSERT() arguments.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportStatusCodeExtractAssertInfo (\r
- IN EFI_STATUS_CODE_TYPE CodeType,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN CONST EFI_STATUS_CODE_DATA *Data,\r
- OUT CHAR8 **Filename,\r
- OUT CHAR8 **Description,\r
- OUT UINT32 *LineNumber\r
- )\r
-{\r
- EFI_DEBUG_ASSERT_DATA *AssertData;\r
-\r
- ASSERT (Data != NULL);\r
- ASSERT (Filename != NULL);\r
- ASSERT (Description != NULL);\r
- ASSERT (LineNumber != NULL);\r
-\r
- if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) &&\r
- ((CodeType & EFI_STATUS_CODE_SEVERITY_MASK) == EFI_ERROR_UNRECOVERED) &&\r
- ((Value & EFI_STATUS_CODE_OPERATION_MASK) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE)) {\r
- AssertData = (EFI_DEBUG_ASSERT_DATA *)(Data + 1);\r
- *Filename = (CHAR8 *)(AssertData + 1);\r
- *Description = *Filename + AsciiStrLen (*Filename) + 1;\r
- *LineNumber = AssertData->LineNumber;\r
- return TRUE;\r
- }\r
- return FALSE;\r
-}\r
-\r
-\r
-/**\r
- Extracts DEBUG() information from a status code structure.\r
-\r
- Converts the status code specified by Data to the DEBUG() arguments specified\r
- by ErrorLevel, Marker, and Format. If type GUID in Data is\r
- EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and\r
- Format from the optional data area of the status code buffer specified by Data.\r
- The optional data area of Data contains a 32-bit ErrorLevel followed by Marker\r
- which is 12 UINTN parameters, followed by a Null-terminated ASCII string for\r
- the Format. If the DEBUG() information could be extracted from Data, then\r
- return TRUE. Otherwise, FALSE is returned.\r
-\r
- If Data is NULL, then ASSERT().\r
- If ErrorLevel is NULL, then ASSERT().\r
- If Marker is NULL, then ASSERT().\r
- If Format is NULL, then ASSERT().\r
-\r
- @param Data Pointer to status code data buffer.\r
- @param ErrorLevel Pointer to error level mask for a debug message.\r
- @param Marker Pointer to the variable argument list associated with Format.\r
- @param Format Pointer to a Null-terminated ASCII format string of a\r
- debug message.\r
-\r
- @retval TRUE The status code specified by Data was converted DEBUG() arguments\r
- specified by ErrorLevel, Marker, and Format.\r
- @retval FALSE The status code specified by Data could not be converted to\r
- DEBUG() arguments.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportStatusCodeExtractDebugInfo (\r
- IN CONST EFI_STATUS_CODE_DATA *Data,\r
- OUT UINT32 *ErrorLevel,\r
- OUT VA_LIST *Marker,\r
- OUT CHAR8 **Format\r
- )\r
-{\r
- EFI_DEBUG_INFO *DebugInfo;\r
-\r
- ASSERT (Data != NULL);\r
- ASSERT (ErrorLevel != NULL);\r
- ASSERT (Marker != NULL);\r
- ASSERT (Format != NULL);\r
-\r
- //\r
- // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE\r
- //\r
- if (!CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid)) {\r
- return FALSE;\r
- }\r
-\r
- //\r
- // Retrieve the debug information from the status code record\r
- //\r
- DebugInfo = (EFI_DEBUG_INFO *)(Data + 1);\r
-\r
- *ErrorLevel = DebugInfo->ErrorLevel;\r
-\r
- //\r
- // The first 12 * UINTN bytes of the string are really an\r
- // argument stack to support varargs on the Format string.\r
- //\r
- *Marker = (VA_LIST) (DebugInfo + 1);\r
- *Format = (CHAR8 *)(((UINT64 *)*Marker) + 12);\r
-\r
- return TRUE;\r
-}\r
-\r
-\r
-/**\r
- Reports a status code.\r
-\r
- Reports the status code specified by the parameters Type and Value. Status\r
- code also require an instance, caller ID, and extended data. This function\r
- passed in a zero instance, NULL extended data, and a caller ID of\r
- gEfiCallerIdGuid, which is the GUID for the module.\r
-\r
- ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode()\r
- is called while processing another any other Report Status Code Library function,\r
- then ReportStatusCode() must return immediately.\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
-\r
- @retval EFI_SUCCESS The status code was reported.\r
- @retval EFI_DEVICE_ERROR There status code could not be reported due to a\r
- device error.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCode (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value\r
- )\r
-{\r
- return InternalReportStatusCode (Type, Value, 0, &gEfiCallerIdGuid, NULL);\r
-}\r
-\r
-\r
-/**\r
- Reports a status code with a Device Path Protocol as the extended data.\r
-\r
- Allocates and fills in the extended data section of a status code with the\r
- Device Path Protocol specified by DevicePath. This function is responsible\r
- for allocating a buffer large enough for the standard header and the device\r
- path. The standard header is filled in with a GUID of\r
- gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero\r
- instance and a caller ID of gEfiCallerIdGuid.\r
-\r
- ReportStatusCodeWithDevicePath()must actively prevent recursion. If\r
- ReportStatusCodeWithDevicePath() is called while processing another any other\r
- Report Status Code Library function, then ReportStatusCodeWithDevicePath()\r
- must return EFI_DEVICE_ERROR immediately.\r
-\r
- If DevicePath is NULL, then ASSERT().\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param DevicePath Pointer to the Device Path Protocol to be reported.\r
-\r
- @retval EFI_SUCCESS The status code was reported with the extended\r
- data specified by DevicePath.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the\r
- extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCodeWithDevicePath (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-{\r
- ASSERT (DevicePath != NULL);\r
- return ReportStatusCodeWithExtendedData (\r
- Type,\r
- Value,\r
- (VOID *)DevicePath,\r
- InternalReportStatusCodeDevicePathSize (DevicePath)\r
- );\r
-}\r
-\r
-\r
-/**\r
- Reports a status code with an extended data buffer.\r
-\r
- Allocates and fills in the extended data section of a status code with the\r
- extended data specified by ExtendedData and ExtendedDataSize. ExtendedData\r
- is assumed to be one of the data structures specified in Related Definitions.\r
- These data structure do not have the standard header, so this function is\r
- responsible for allocating a buffer large enough for the standard header and\r
- the extended data passed into this function. The standard header is filled\r
- in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported\r
- with a zero instance and a caller ID of gEfiCallerIdGuid.\r
-\r
- ReportStatusCodeWithExtendedData()must actively prevent recursion. If\r
- ReportStatusCodeWithExtendedData() is called while processing another any other\r
- Report Status Code Library function, then ReportStatusCodeWithExtendedData()\r
- must return EFI_DEVICE_ERROR immediately.\r
-\r
- If ExtendedData is NULL, then ASSERT().\r
- If ExtendedDataSize is 0, then ASSERT().\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param ExtendedData Pointer to the extended data buffer to be reported.\r
- @param ExtendedDataSize The size, in bytes, of the extended data buffer to\r
- be reported.\r
-\r
- @retval EFI_SUCCESS The status code was reported with the extended\r
- data specified by ExtendedData and ExtendedDataSize.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the\r
- extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCodeWithExtendedData (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN CONST VOID *ExtendedData,\r
- IN UINTN ExtendedDataSize\r
- )\r
-{\r
- ASSERT (ExtendedData != NULL);\r
- ASSERT (ExtendedDataSize != 0);\r
- return ReportStatusCodeEx (\r
- Type,\r
- Value,\r
- 0,\r
- NULL,\r
- NULL,\r
- ExtendedData,\r
- ExtendedDataSize\r
- );\r
-}\r
-\r
-\r
-/**\r
- Reports a status code with full parameters.\r
-\r
- The function reports a status code. If ExtendedData is NULL and ExtendedDataSize\r
- is 0, then an extended data buffer is not reported. If ExtendedData is not\r
- NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.\r
- ExtendedData is assumed not have the standard status code header, so this function\r
- is responsible for allocating a buffer large enough for the standard header and\r
- the extended data passed into this function. The standard header is filled in\r
- with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a\r
- GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with\r
- an instance specified by Instance and a caller ID specified by CallerId. If\r
- CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
-\r
- ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx()\r
- is called while processing another any other Report Status Code Library function,\r
- then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.\r
-\r
- If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
- If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this\r
- function. If this parameter is NULL, then a caller\r
- ID of gEfiCallerIdGuid is used.\r
- @param ExtendedDataGuid Pointer to the GUID for the extended data buffer.\r
- If this parameter is NULL, then a the status code\r
- standard header is filled in with\r
- gEfiStatusCodeSpecificDataGuid.\r
- @param ExtendedData Pointer to the extended data buffer. This is an\r
- optional parameter that may be NULL.\r
- @param ExtendedDataSize The size, in bytes, of the extended data buffer.\r
-\r
- @retval EFI_SUCCESS The status code was reported.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate\r
- the extended data section if it was specified.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCodeEx (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN UINT32 Instance,\r
- IN CONST EFI_GUID *CallerId OPTIONAL,\r
- IN CONST EFI_GUID *ExtendedDataGuid OPTIONAL,\r
- IN CONST VOID *ExtendedData OPTIONAL,\r
- IN UINTN ExtendedDataSize\r
- )\r
-{\r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled\r
-\r
- This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED\r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is set.\r
- @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportProgressCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);\r
-}\r
-\r
-\r
-/**\r
- Returns TRUE if status codes of type EFI_ERROR_CODE are enabled\r
-\r
- This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED\r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is set.\r
- @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportErrorCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);\r
-}\r
-\r
-\r
-/**\r
- Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled\r
-\r
- This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED\r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is set.\r
- @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportDebugCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
-}\r
+++ /dev/null
-#/** @file\r
-# DXE report status code library\r
-#\r
-# Retrieve status code and report status code in DXE phase\r
-# Copyright (c) 2006 - 2007, Intel Corporation.\r
-#\r
-# All rights reserved. This program and the accompanying materials\r
-# are licensed and made available under the terms and conditions of the BSD License\r
-# which accompanies this distribution. The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php\r
-# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-#\r
-#\r
-#**/\r
-\r
-[Defines]\r
- INF_VERSION = 0x00010005\r
- BASE_NAME = BaseReportStatusCodeLib\r
- FILE_GUID = 1DE0B8C2-FFB6-4bdf-97F5-0FFB33979038\r
- MODULE_TYPE = BASE\r
- VERSION_STRING = 1.0\r
- LIBRARY_CLASS = ReportStatusCodeLib|BASE SEC USER_DEFINED\r
- EDK_RELEASE_VERSION = 0x00020000\r
- EFI_SPECIFICATION_VERSION = 0x00020000\r
-\r
-\r
-#\r
-# The following information is for reference only and not required by the build tools.\r
-#\r
-# VALID_ARCHITECTURES = IA32 X64 IPF EBC\r
-#\r
-\r
-[Sources.common]\r
- BaseReportStatusCodeLib.c\r
-\r
-\r
-\r
-[Packages]\r
- MdePkg/MdePkg.dec\r
- IntelFrameworkPkg/IntelFrameworkPkg.dec\r
-\r
-\r
-[LibraryClasses]\r
- PcdLib\r
- BaseMemoryLib\r
- BaseLib\r
- DebugLib\r
-\r
-\r
-[Guids]\r
- gEfiStatusCodeSpecificDataGuid # ALWAYS_CONSUMED\r
- gEfiStatusCodeDataTypeDebugGuid # ALWAYS_CONSUMED\r
-\r
-\r
-[PcdsFixedAtBuild.common]\r
- PcdReportStatusCodePropertyMask|gEfiMdePkgTokenSpaceGuid\r
-\r
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>\r
-<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">\r
- <MsaHeader>\r
- <ModuleName>DxeReportStatusCodeLib</ModuleName>\r
- <ModuleType>BASE</ModuleType>\r
- <GuidValue>1DE0B8C2-FFB6-4bdf-97F5-0FFB33979038</GuidValue>\r
- <Version>1.0</Version>\r
- <Abstract>DXE report status code library</Abstract>\r
- <Description>Retrieve status code and report status code in DXE phase</Description>\r
- <Copyright>Copyright (c) 2006 - 2007, Intel Corporation.</Copyright>\r
- <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>\r
- <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052</Specification>\r
- </MsaHeader>\r
- <ModuleDefinitions>\r
- <SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>\r
- <BinaryModule>false</BinaryModule>\r
- <OutputFileBasename>BaseReportStatusCodeLib</OutputFileBasename>\r
- </ModuleDefinitions>\r
- <LibraryClassDefinitions>\r
- <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="BASE">\r
- <Keyword>ReportStatusCodeLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>DebugLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>BaseLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>BaseMemoryLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>PcdLib</Keyword>\r
- </LibraryClass>\r
- </LibraryClassDefinitions>\r
- <SourceFiles>\r
- <Filename>BaseReportStatusCodeLib.c</Filename>\r
- </SourceFiles>\r
- <PackageDependencies>\r
- <Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>\r
- </PackageDependencies>\r
- <Guids>\r
- <GuidCNames Usage="ALWAYS_CONSUMED">\r
- <GuidCName>gEfiStatusCodeDataTypeDebugGuid</GuidCName>\r
- </GuidCNames>\r
- <GuidCNames Usage="ALWAYS_CONSUMED">\r
- <GuidCName>gEfiStatusCodeSpecificDataGuid</GuidCName>\r
- </GuidCNames>\r
- </Guids>\r
- <Externs>\r
- <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>\r
- <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>\r
- </Externs>\r
- <PcdCoded>\r
- <PcdEntry PcdItemType="FIXED_AT_BUILD">\r
- <C_Name>PcdReportStatusCodePropertyMask</C_Name>\r
- <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
- <HelpText>The bitmask of flags that specify the enable/disable of
- Progress Code, Error Code and Debug Code.</HelpText>\r
- </PcdEntry>\r
- </PcdCoded>\r
-</ModuleSurfaceArea>
\ No newline at end of file
+++ /dev/null
-#/** @file\r
-# DXE report status code library\r
-#\r
-# Retrieve status code and report status code in DXE phase\r
-# Copyright (c) 2006 - 2007, Intel Corporation.\r
-#\r
-# All rights reserved. This program and the accompanying materials\r
-# are licensed and made available under the terms and conditions of the BSD License\r
-# which accompanies this distribution. The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php\r
-# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-#\r
-#\r
-#**/\r
-\r
-[Defines]\r
- INF_VERSION = 0x00010005\r
- BASE_NAME = DxeReportStatusCodeLib\r
- FILE_GUID = 3ddc3b12-99ea-4364-b315-6310a2050be5\r
- MODULE_TYPE = DXE_DRIVER\r
- VERSION_STRING = 1.0\r
- LIBRARY_CLASS = ReportStatusCodeLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER\r
- EDK_RELEASE_VERSION = 0x00020000\r
- EFI_SPECIFICATION_VERSION = 0x00020000\r
-\r
-\r
-#\r
-# The following information is for reference only and not required by the build tools.\r
-#\r
-# VALID_ARCHITECTURES = IA32 X64 IPF EBC\r
-#\r
-\r
-[Sources.common]\r
- ReportStatusCodeLib.c\r
-\r
-\r
-\r
-[Packages]\r
- MdePkg/MdePkg.dec\r
- IntelFrameworkPkg/IntelFrameworkPkg.dec\r
-\r
-\r
-[LibraryClasses]\r
- PcdLib\r
- BaseMemoryLib\r
- BaseLib\r
- UefiBootServicesTableLib\r
- DebugLib\r
- UefiRuntimeServicesTableLib\r
-\r
-\r
-[Guids]\r
- gEfiStatusCodeSpecificDataGuid # ALWAYS_CONSUMED\r
- gEfiStatusCodeDataTypeDebugGuid # ALWAYS_CONSUMED\r
-\r
-\r
-[Protocols]\r
- gEfiStatusCodeRuntimeProtocolGuid # PROTOCOL ALWAYS_CONSUMED\r
-\r
-\r
-[PcdsFixedAtBuild.common]\r
- PcdReportStatusCodePropertyMask|gEfiMdePkgTokenSpaceGuid\r
-\r
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>\r
-<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">\r
- <MsaHeader>\r
- <ModuleName>DxeReportStatusCodeLib</ModuleName>\r
- <ModuleType>DXE_DRIVER</ModuleType>\r
- <GuidValue>3ddc3b12-99ea-4364-b315-6310a2050be5</GuidValue>\r
- <Version>1.0</Version>\r
- <Abstract>DXE report status code library</Abstract>\r
- <Description>Retrieve status code and report status code in DXE phase</Description>\r
- <Copyright>Copyright (c) 2006 - 2007, Intel Corporation.</Copyright>\r
- <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>\r
- <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052</Specification>\r
- </MsaHeader>\r
- <ModuleDefinitions>\r
- <SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>\r
- <BinaryModule>false</BinaryModule>\r
- <OutputFileBasename>DxeReportStatusCodeLib</OutputFileBasename>\r
- </ModuleDefinitions>\r
- <LibraryClassDefinitions>\r
- <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER">\r
- <Keyword>ReportStatusCodeLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>DebugLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>UefiBootServicesTableLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>BaseLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>BaseMemoryLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>PcdLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>UefiRuntimeServicesTableLib</Keyword>\r
- </LibraryClass>\r
- </LibraryClassDefinitions>\r
- <SourceFiles>\r
- <Filename>ReportStatusCodeLib.c</Filename>\r
- </SourceFiles>\r
- <PackageDependencies>\r
- <Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>\r
- </PackageDependencies>\r
- <Protocols>\r
- <Protocol Usage="ALWAYS_CONSUMED">\r
- <ProtocolCName>gEfiStatusCodeRuntimeProtocolGuid</ProtocolCName>\r
- </Protocol>\r
- </Protocols>\r
- <Guids>\r
- <GuidCNames Usage="ALWAYS_CONSUMED">\r
- <GuidCName>gEfiStatusCodeDataTypeDebugGuid</GuidCName>\r
- </GuidCNames>\r
- <GuidCNames Usage="ALWAYS_CONSUMED">\r
- <GuidCName>gEfiStatusCodeSpecificDataGuid</GuidCName>\r
- </GuidCNames>\r
- </Guids>\r
- <Externs>\r
- <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>\r
- <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>\r
- </Externs>\r
- <PcdCoded>\r
- <PcdEntry PcdItemType="FIXED_AT_BUILD">\r
- <C_Name>PcdReportStatusCodePropertyMask</C_Name>\r
- <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
- <HelpText>The bitmask of flags that specify the enable/disable of
- Progress Code, Error Code and Debug Code.</HelpText>\r
- </PcdEntry>\r
- </PcdCoded>\r
-</ModuleSurfaceArea>
\ No newline at end of file
+++ /dev/null
-/** @file\r
- Report Status Code Library for DXE Phase.\r
-\r
- Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-**/\r
-\r
-\r
-#include <FrameworkDxe.h>\r
-\r
-#include <Guid/StatusCodeDataTypeId.h>\r
-#include <Protocol/StatusCode.h>\r
-\r
-#include <Library/ReportStatusCodeLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-#include <Library/BaseLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/PcdLib.h>\r
-#include <Library/UefiRuntimeServicesTableLib.h>\r
-\r
-\r
-/**\r
- Internal worker function that reports a status code through the Status Code Protocol\r
-\r
- This function checks to see if a Status Code Protocol is present in the handle\r
- database. If a Status Code Protocol is not present, then EFI_UNSUPPORTED is\r
- returned. If a Status Code Protocol is present, then it is cached in gStatusCode,\r
- and the ReportStatusCode() service of the Status Code Protocol is called passing in\r
- Type, Value, Instance, CallerId, and Data. The result of this call is returned.\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this\r
- function. This is an optional parameter that may be\r
- NULL.\r
- @param Data Pointer to the extended data buffer. This is an\r
- optional parameter that may be NULL.\r
-\r
- @retval EFI_SUCCESS The status code was reported.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to report the status code.\r
- @retval EFI_UNSUPPORTED Status Code Protocol is not available.\r
-\r
-**/\r
-STATIC\r
-EFI_STATUS\r
-InternalReportStatusCode (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN UINT32 Instance,\r
- IN CONST EFI_GUID *CallerId OPTIONAL,\r
- IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_STATUS_CODE_PROTOCOL *StatusCode;\r
- STATIC EFI_REPORT_STATUS_CODE ReportStatusCode = NULL;\r
-\r
- //\r
- // If gStatusCode is NULL, then see if a Status Code Protocol instance is present\r
- // in the handle database.\r
- //\r
- if (ReportStatusCode == NULL) {\r
- if (gBS == NULL) {\r
- return EFI_UNSUPPORTED;\r
- }\r
- Status = gBS->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid, NULL, (VOID**)&StatusCode);\r
- if (!EFI_ERROR (Status) && StatusCode != NULL) {\r
- ReportStatusCode = StatusCode->ReportStatusCode;\r
- } else if (gRT->Hdr.Revision < 0x20000) {\r
- ReportStatusCode = ((FRAMEWORK_EFI_RUNTIME_SERVICES*)gRT)->ReportStatusCode;\r
- } else {\r
- return EFI_UNSUPPORTED;\r
- }\r
- }\r
-\r
- //\r
- // A Status Code Protocol is present in the handle database, so pass in all the\r
- // parameters to the ReportStatusCode() service of the Status Code Protocol\r
- //\r
- return (*ReportStatusCode) (Type, Value, Instance, (EFI_GUID *)CallerId, Data);\r
-}\r
-\r
-\r
-/**\r
- Computes and returns the size, in bytes, of a device path.\r
-\r
- @param DevicePath A pointer to a device path.\r
-\r
- @return The size, in bytes, of DevicePath.\r
-\r
-**/\r
-STATIC\r
-UINTN\r
-InternalReportStatusCodeDevicePathSize (\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-{\r
- CONST EFI_DEVICE_PATH_PROTOCOL *Start;\r
-\r
- //\r
- // Search for the end of the device path structure\r
- //\r
- Start = DevicePath;\r
- while (!EfiIsDevicePathEnd (DevicePath)) {\r
- DevicePath = EfiNextDevicePathNode (DevicePath);\r
- }\r
-\r
- //\r
- // Subtract the start node from the end node and add in the size of the end node\r
- //\r
- return ((UINTN) DevicePath - (UINTN) Start) + DevicePathNodeLength (DevicePath);\r
-}\r
-\r
-\r
-/**\r
- Converts a status code to an 8-bit POST code value.\r
-\r
- Converts the status code specified by CodeType and Value to an 8-bit POST code\r
- and returns the 8-bit POST code in PostCode. If CodeType is an\r
- EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode\r
- are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits\r
- 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.\r
-\r
- If PostCode is NULL, then ASSERT().\r
-\r
- @param CodeType The type of status code being converted.\r
- @param Value The status code value being converted.\r
- @param PostCode A pointer to the 8-bit POST code value to return.\r
-\r
- @retval TRUE The status code specified by CodeType and Value was converted\r
- to an 8-bit POST code and returned in PostCode.\r
- @retval FALSE The status code specified by CodeType and Value could not be\r
- converted to an 8-bit POST code value.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-CodeTypeToPostCode (\r
- IN EFI_STATUS_CODE_TYPE CodeType,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- OUT UINT8 *PostCode\r
- )\r
-{\r
- //\r
- // If PostCode is NULL, then ASSERT()\r
- //\r
- ASSERT (PostCode != NULL);\r
-\r
- //\r
- // Convert Value to an 8 bit post code\r
- //\r
- if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||\r
- ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) ) {\r
- *PostCode = (UINT8) ((((Value & EFI_STATUS_CODE_CLASS_MASK) >> 24) << 5) |\r
- (((Value & EFI_STATUS_CODE_SUBCLASS_MASK) >> 16) & 0x1f));\r
- return TRUE;\r
- }\r
- return FALSE;\r
-}\r
-\r
-\r
-/**\r
- Extracts ASSERT() information from a status code structure.\r
-\r
- Converts the status code specified by CodeType, Value, and Data to the ASSERT()\r
- arguments specified by Filename, Description, and LineNumber. If CodeType is\r
- an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and\r
- Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract\r
- Filename, Description, and LineNumber from the optional data area of the\r
- status code buffer specified by Data. The optional data area of Data contains\r
- a Null-terminated ASCII string for the FileName, followed by a Null-terminated\r
- ASCII string for the Description, followed by a 32-bit LineNumber. If the\r
- ASSERT() information could be extracted from Data, then return TRUE.\r
- Otherwise, FALSE is returned.\r
-\r
- If Data is NULL, then ASSERT().\r
- If Filename is NULL, then ASSERT().\r
- If Description is NULL, then ASSERT().\r
- If LineNumber is NULL, then ASSERT().\r
-\r
- @param CodeType The type of status code being converted.\r
- @param Value The status code value being converted.\r
- @param Data Pointer to status code data buffer.\r
- @param Filename Pointer to the source file name that generated the ASSERT().\r
- @param Description Pointer to the description of the ASSERT().\r
- @param LineNumber Pointer to source line number that generated the ASSERT().\r
-\r
- @retval TRUE The status code specified by CodeType, Value, and Data was\r
- converted ASSERT() arguments specified by Filename, Description,\r
- and LineNumber.\r
- @retval FALSE The status code specified by CodeType, Value, and Data could\r
- not be converted to ASSERT() arguments.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportStatusCodeExtractAssertInfo (\r
- IN EFI_STATUS_CODE_TYPE CodeType,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN CONST EFI_STATUS_CODE_DATA *Data,\r
- OUT CHAR8 **Filename,\r
- OUT CHAR8 **Description,\r
- OUT UINT32 *LineNumber\r
- )\r
-{\r
- EFI_DEBUG_ASSERT_DATA *AssertData;\r
-\r
- ASSERT (Data != NULL);\r
- ASSERT (Filename != NULL);\r
- ASSERT (Description != NULL);\r
- ASSERT (LineNumber != NULL);\r
-\r
- if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) &&\r
- ((CodeType & EFI_STATUS_CODE_SEVERITY_MASK) == EFI_ERROR_UNRECOVERED) &&\r
- ((Value & EFI_STATUS_CODE_OPERATION_MASK) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE)) {\r
- AssertData = (EFI_DEBUG_ASSERT_DATA *)(Data + 1);\r
- *Filename = (CHAR8 *)(AssertData + 1);\r
- *Description = *Filename + AsciiStrLen (*Filename) + 1;\r
- *LineNumber = AssertData->LineNumber;\r
- return TRUE;\r
- }\r
- return FALSE;\r
-}\r
-\r
-\r
-/**\r
- Extracts DEBUG() information from a status code structure.\r
-\r
- Converts the status code specified by Data to the DEBUG() arguments specified\r
- by ErrorLevel, Marker, and Format. If type GUID in Data is\r
- EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and\r
- Format from the optional data area of the status code buffer specified by Data.\r
- The optional data area of Data contains a 32-bit ErrorLevel followed by Marker\r
- which is 12 UINTN parameters, followed by a Null-terminated ASCII string for\r
- the Format. If the DEBUG() information could be extracted from Data, then\r
- return TRUE. Otherwise, FALSE is returned.\r
-\r
- If Data is NULL, then ASSERT().\r
- If ErrorLevel is NULL, then ASSERT().\r
- If Marker is NULL, then ASSERT().\r
- If Format is NULL, then ASSERT().\r
-\r
- @param Data Pointer to status code data buffer.\r
- @param ErrorLevel Pointer to error level mask for a debug message.\r
- @param Marker Pointer to the variable argument list associated with Format.\r
- @param Format Pointer to a Null-terminated ASCII format string of a\r
- debug message.\r
-\r
- @retval TRUE The status code specified by Data was converted DEBUG() arguments\r
- specified by ErrorLevel, Marker, and Format.\r
- @retval FALSE The status code specified by Data could not be converted to\r
- DEBUG() arguments.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportStatusCodeExtractDebugInfo (\r
- IN CONST EFI_STATUS_CODE_DATA *Data,\r
- OUT UINT32 *ErrorLevel,\r
- OUT VA_LIST *Marker,\r
- OUT CHAR8 **Format\r
- )\r
-{\r
- EFI_DEBUG_INFO *DebugInfo;\r
-\r
- ASSERT (Data != NULL);\r
- ASSERT (ErrorLevel != NULL);\r
- ASSERT (Marker != NULL);\r
- ASSERT (Format != NULL);\r
-\r
- //\r
- // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE\r
- //\r
- if (!CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid)) {\r
- return FALSE;\r
- }\r
-\r
- //\r
- // Retrieve the debug information from the status code record\r
- //\r
- DebugInfo = (EFI_DEBUG_INFO *)(Data + 1);\r
-\r
- *ErrorLevel = DebugInfo->ErrorLevel;\r
-\r
- //\r
- // The first 12 * UINTN bytes of the string are really an\r
- // argument stack to support varargs on the Format string.\r
- //\r
- *Marker = (VA_LIST) (DebugInfo + 1);\r
- *Format = (CHAR8 *)(((UINT64 *)*Marker) + 12);\r
-\r
- return TRUE;\r
-}\r
-\r
-\r
-/**\r
- Reports a status code.\r
-\r
- Reports the status code specified by the parameters Type and Value. Status\r
- code also require an instance, caller ID, and extended data. This function\r
- passed in a zero instance, NULL extended data, and a caller ID of\r
- gEfiCallerIdGuid, which is the GUID for the module.\r
-\r
- ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode()\r
- is called while processing another any other Report Status Code Library function,\r
- then ReportStatusCode() must return immediately.\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
-\r
- @retval EFI_SUCCESS The status code was reported.\r
- @retval EFI_DEVICE_ERROR There status code could not be reported due to a\r
- device error.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCode (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value\r
- )\r
-{\r
- return InternalReportStatusCode (Type, Value, 0, &gEfiCallerIdGuid, NULL);\r
-}\r
-\r
-\r
-/**\r
- Reports a status code with a Device Path Protocol as the extended data.\r
-\r
- Allocates and fills in the extended data section of a status code with the\r
- Device Path Protocol specified by DevicePath. This function is responsible\r
- for allocating a buffer large enough for the standard header and the device\r
- path. The standard header is filled in with a GUID of\r
- gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero\r
- instance and a caller ID of gEfiCallerIdGuid.\r
-\r
- ReportStatusCodeWithDevicePath()must actively prevent recursion. If\r
- ReportStatusCodeWithDevicePath() is called while processing another any other\r
- Report Status Code Library function, then ReportStatusCodeWithDevicePath()\r
- must return EFI_DEVICE_ERROR immediately.\r
-\r
- If DevicePath is NULL, then ASSERT().\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param DevicePath Pointer to the Device Path Protocol to be reported.\r
-\r
- @retval EFI_SUCCESS The status code was reported with the extended\r
- data specified by DevicePath.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the\r
- extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCodeWithDevicePath (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-{\r
- ASSERT (DevicePath != NULL);\r
- return ReportStatusCodeWithExtendedData (\r
- Type,\r
- Value,\r
- (VOID *)DevicePath,\r
- InternalReportStatusCodeDevicePathSize (DevicePath)\r
- );\r
-}\r
-\r
-\r
-/**\r
- Reports a status code with an extended data buffer.\r
-\r
- Allocates and fills in the extended data section of a status code with the\r
- extended data specified by ExtendedData and ExtendedDataSize. ExtendedData\r
- is assumed to be one of the data structures specified in Related Definitions.\r
- These data structure do not have the standard header, so this function is\r
- responsible for allocating a buffer large enough for the standard header and\r
- the extended data passed into this function. The standard header is filled\r
- in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported\r
- with a zero instance and a caller ID of gEfiCallerIdGuid.\r
-\r
- ReportStatusCodeWithExtendedData()must actively prevent recursion. If\r
- ReportStatusCodeWithExtendedData() is called while processing another any other\r
- Report Status Code Library function, then ReportStatusCodeWithExtendedData()\r
- must return EFI_DEVICE_ERROR immediately.\r
-\r
- If ExtendedData is NULL, then ASSERT().\r
- If ExtendedDataSize is 0, then ASSERT().\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param ExtendedData Pointer to the extended data buffer to be reported.\r
- @param ExtendedDataSize The size, in bytes, of the extended data buffer to\r
- be reported.\r
-\r
- @retval EFI_SUCCESS The status code was reported with the extended\r
- data specified by ExtendedData and ExtendedDataSize.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the\r
- extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCodeWithExtendedData (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN CONST VOID *ExtendedData,\r
- IN UINTN ExtendedDataSize\r
- )\r
-{\r
- ASSERT (ExtendedData != NULL);\r
- ASSERT (ExtendedDataSize != 0);\r
- return ReportStatusCodeEx (\r
- Type,\r
- Value,\r
- 0,\r
- NULL,\r
- NULL,\r
- ExtendedData,\r
- ExtendedDataSize\r
- );\r
-}\r
-\r
-\r
-/**\r
- Reports a status code with full parameters.\r
-\r
- The function reports a status code. If ExtendedData is NULL and ExtendedDataSize\r
- is 0, then an extended data buffer is not reported. If ExtendedData is not\r
- NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.\r
- ExtendedData is assumed not have the standard status code header, so this function\r
- is responsible for allocating a buffer large enough for the standard header and\r
- the extended data passed into this function. The standard header is filled in\r
- with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a\r
- GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with\r
- an instance specified by Instance and a caller ID specified by CallerId. If\r
- CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
-\r
- ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx()\r
- is called while processing another any other Report Status Code Library function,\r
- then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.\r
-\r
- If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
- If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this\r
- function. If this parameter is NULL, then a caller\r
- ID of gEfiCallerIdGuid is used.\r
- @param ExtendedDataGuid Pointer to the GUID for the extended data buffer.\r
- If this parameter is NULL, then a the status code\r
- standard header is filled in with\r
- gEfiStatusCodeSpecificDataGuid.\r
- @param ExtendedData Pointer to the extended data buffer. This is an\r
- optional parameter that may be NULL.\r
- @param ExtendedDataSize The size, in bytes, of the extended data buffer.\r
-\r
- @retval EFI_SUCCESS The status code was reported.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate\r
- the extended data section if it was specified.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCodeEx (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN UINT32 Instance,\r
- IN CONST EFI_GUID *CallerId OPTIONAL,\r
- IN CONST EFI_GUID *ExtendedDataGuid OPTIONAL,\r
- IN CONST VOID *ExtendedData OPTIONAL,\r
- IN UINTN ExtendedDataSize\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_STATUS_CODE_DATA *StatusCodeData;\r
-\r
- ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));\r
- ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));\r
-\r
- if (gBS == NULL) {\r
- return EFI_UNSUPPORTED;\r
- }\r
-\r
- //\r
- // Allocate space for the Status Code Header and its buffer\r
- //\r
- StatusCodeData = NULL;\r
- gBS->AllocatePool (EfiBootServicesData, sizeof (EFI_STATUS_CODE_DATA) + ExtendedDataSize, (VOID **)&StatusCodeData);\r
- if (StatusCodeData == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- //\r
- // Fill in the extended data header\r
- //\r
- StatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);\r
- StatusCodeData->Size = (UINT16)ExtendedDataSize;\r
- if (ExtendedDataGuid == NULL) {\r
- ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;\r
- }\r
- CopyGuid (&StatusCodeData->Type, ExtendedDataGuid);\r
-\r
- //\r
- // Fill in the extended data buffer\r
- //\r
- CopyMem (StatusCodeData + 1, ExtendedData, ExtendedDataSize);\r
-\r
- //\r
- // Report the status code\r
- //\r
- if (CallerId == NULL) {\r
- CallerId = &gEfiCallerIdGuid;\r
- }\r
- Status = InternalReportStatusCode (Type, Value, Instance, CallerId, StatusCodeData);\r
-\r
- //\r
- // Free the allocated buffer\r
- //\r
- gBS->FreePool (StatusCodeData);\r
-\r
- return Status;\r
-}\r
-\r
-\r
-/**\r
- Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled\r
-\r
- This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED\r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is set.\r
- @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportProgressCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);\r
-}\r
-\r
-\r
-/**\r
- Returns TRUE if status codes of type EFI_ERROR_CODE are enabled\r
-\r
- This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED\r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is set.\r
- @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportErrorCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);\r
-}\r
-\r
-\r
-/**\r
- Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled\r
-\r
- This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED\r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is set.\r
- @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportDebugCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
-}\r
+++ /dev/null
-/** @file\r
- Debug Library that fowards all messages to ReportStatusCode()\r
-\r
- Copyright (c) 2006, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-**/\r
-\r
-\r
-\r
-#include <FrameworkPei.h>\r
-\r
-#include <Guid/StatusCodeDataTypeId.h>\r
-\r
-#include <Library/DebugLib.h>\r
-#include <Library/BaseLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/ReportStatusCodeLib.h>\r
-#include <Library/PcdLib.h>\r
-\r
-/**\r
-\r
- Prints a debug message to the debug output device if the specified error level is enabled.\r
-\r
- If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print\r
- the message specified by Format and the associated variable argument list to\r
- the debug output device.\r
-\r
- If Format is NULL, then ASSERT().\r
-\r
- @param ErrorLevel The error level of the debug message.\r
- @param Format Format string for the debug message to print.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-DebugPrint (\r
- IN UINTN ErrorLevel,\r
- IN CONST CHAR8 *Format,\r
- ...\r
- )\r
-{\r
- UINT64 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof (UINT64)];\r
- EFI_DEBUG_INFO *DebugInfo;\r
- UINTN TotalSize;\r
- UINTN Index;\r
- VA_LIST Marker;\r
- UINT64 *ArgumentPointer;\r
-\r
- //\r
- // If Format is NULL, then ASSERT().\r
- //\r
- ASSERT (Format != NULL);\r
-\r
- //\r
- // Check driver Debug Level value and global debug level\r
- //\r
- if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {\r
- return;\r
- }\r
-\r
- TotalSize = sizeof (EFI_DEBUG_INFO) + 12 * sizeof (UINT64) + AsciiStrLen (Format) + 1;\r
- if (TotalSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
- return;\r
- }\r
-\r
- //\r
- // Then EFI_DEBUG_INFO\r
- //\r
- DebugInfo = (EFI_DEBUG_INFO *)Buffer;\r
- DebugInfo->ErrorLevel = (UINT32)ErrorLevel;\r
-\r
- //\r
- // 256 byte mini Var Arg stack. That is followed by the format string.\r
- //\r
- VA_START (Marker, Format);\r
- for (Index = 0, ArgumentPointer = (UINT64 *)(DebugInfo + 1); Index < 12; Index++, ArgumentPointer++) {\r
- WriteUnaligned64(ArgumentPointer, VA_ARG (Marker, UINT64));\r
- }\r
- VA_END (Marker);\r
- AsciiStrCpy ((CHAR8 *)ArgumentPointer, Format);\r
-\r
- REPORT_STATUS_CODE_EX (\r
- EFI_DEBUG_CODE,\r
- (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_DC_UNSPECIFIED),\r
- 0,\r
- NULL,\r
- &gEfiStatusCodeDataTypeDebugGuid,\r
- DebugInfo,\r
- TotalSize\r
- );\r
-}\r
-\r
-\r
-/**\r
-\r
- Prints an assert message containing a filename, line number, and description.\r
- This may be followed by a breakpoint or a dead loop.\r
-\r
- Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
- to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of\r
- PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if\r
- DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then\r
- CpuDeadLoop() is called. If neither of these bits are set, then this function\r
- returns immediately after the message is printed to the debug output device.\r
- DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while\r
- processing another DebugAssert(), then DebugAssert() must return immediately.\r
-\r
- If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
-\r
- If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
-\r
- @param FileName Pointer to the name of the source file that generated the assert condition.\r
- @param LineNumber The line number in the source file that generated the assert condition\r
- @param Description Pointer to the description of the assert condition.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-DebugAssert (\r
- IN CONST CHAR8 *FileName,\r
- IN UINTN LineNumber,\r
- IN CONST CHAR8 *Description\r
- )\r
-{\r
- UINT64 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof(UINT64)];\r
- EFI_DEBUG_ASSERT_DATA *AssertData;\r
- UINTN TotalSize;\r
- CHAR8 *Temp;\r
- UINTN FileNameLength;\r
- UINTN DescriptionLength;\r
-\r
- //\r
- // Make sure it will all fit in the passed in buffer\r
- //\r
- FileNameLength = AsciiStrLen (FileName);\r
- DescriptionLength = AsciiStrLen (Description);\r
- TotalSize = sizeof (EFI_DEBUG_ASSERT_DATA) + FileNameLength + 1 + DescriptionLength + 1;\r
- if (TotalSize <= EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
- //\r
- // Fill in EFI_DEBUG_ASSERT_DATA\r
- //\r
- AssertData = (EFI_DEBUG_ASSERT_DATA *)Buffer;\r
- AssertData->LineNumber = (UINT32)LineNumber;\r
-\r
- //\r
- // Copy Ascii FileName including NULL.\r
- //\r
- Temp = AsciiStrCpy ((CHAR8 *)(AssertData + 1), FileName);\r
-\r
- //\r
- // Copy Ascii Description\r
- //\r
- AsciiStrCpy (Temp + AsciiStrLen (FileName) + 1, Description);\r
-\r
- REPORT_STATUS_CODE_WITH_EXTENDED_DATA (\r
- (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),\r
- (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),\r
- AssertData,\r
- TotalSize\r
- );\r
- }\r
-\r
- //\r
- // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
- //\r
- if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
- CpuBreakpoint ();\r
- } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
- CpuDeadLoop ();\r
- }\r
-}\r
-\r
-\r
-/**\r
-\r
- Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
-\r
- This function fills Length bytes of Buffer with the value specified by\r
- PcdDebugClearMemoryValue, and returns Buffer.\r
-\r
- If Buffer is NULL, then ASSERT().\r
-\r
- If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().\r
-\r
- @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
- @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.\r
-\r
- @return Buffer\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-DebugClearMemory (\r
- OUT VOID *Buffer,\r
- IN UINTN Length\r
- )\r
-{\r
- //\r
- // If Buffer is NULL, then ASSERT().\r
- //\r
- ASSERT (Buffer != NULL);\r
-\r
- //\r
- // SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
- //\r
- return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
-}\r
-\r
-\r
-/**\r
-\r
- Returns TRUE if ASSERT() macros are enabled.\r
-\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of\r
- PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-DebugAssertEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
-}\r
-\r
-\r
-/**\r
-\r
- Returns TRUE if DEBUG()macros are enabled.\r
-\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of\r
- PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-DebugPrintEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
-}\r
-\r
-\r
-/**\r
-\r
- Returns TRUE if DEBUG_CODE()macros are enabled.\r
-\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of\r
- PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-DebugCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
-}\r
-\r
-\r
-/**\r
-\r
- Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
-\r
- This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of\r
- PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
- @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-DebugClearMemoryEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
-}\r
+++ /dev/null
-#/** @file\r
-# Debug Library based on report status code library\r
-#\r
-# Debug Library for PEIMs and DXE drivers that send debug messages to ReportStatusCode\r
-# Copyright (c) 2006, Intel Corporation.\r
-#\r
-# All rights reserved. This program and the accompanying materials\r
-# are licensed and made available under the terms and conditions of the BSD License\r
-# which accompanies this distribution. The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php\r
-# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-#\r
-#\r
-#**/\r
-\r
-[Defines]\r
- INF_VERSION = 0x00010005\r
- BASE_NAME = PeiDxeDebugLibReportStatusCode\r
- FILE_GUID = bda39d3a-451b-4350-8266-81ab10fa0523\r
- MODULE_TYPE = PEIM\r
- VERSION_STRING = 1.0\r
- LIBRARY_CLASS = DebugLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER PEIM PEI_CORE UEFI_APPLICATION UEFI_DRIVER\r
- EDK_RELEASE_VERSION = 0x00020000\r
- EFI_SPECIFICATION_VERSION = 0x00020000\r
-\r
-\r
-#\r
-# The following information is for reference only and not required by the build tools.\r
-#\r
-# VALID_ARCHITECTURES = IA32 X64 IPF EBC\r
-#\r
-\r
-[Sources.common]\r
- DebugLib.c\r
-\r
-\r
-[Packages]\r
- MdePkg/MdePkg.dec\r
- IntelFrameworkPkg/IntelFrameworkPkg.dec\r
-\r
-[LibraryClasses]\r
- PcdLib\r
- ReportStatusCodeLib\r
- BaseMemoryLib\r
- BaseLib\r
-\r
-\r
-[PcdsFixedAtBuild.common]\r
- PcdDebugClearMemoryValue|gEfiMdePkgTokenSpaceGuid\r
- PcdDebugPropertyMask|gEfiMdePkgTokenSpaceGuid\r
-\r
-\r
-[PcdsDynamic.common]\r
- PcdDebugPrintErrorLevel|gEfiMdePkgTokenSpaceGuid\r
-\r
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>\r
-<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">\r
- <MsaHeader>\r
- <ModuleName>PeiDxeDebugLibReportStatusCode</ModuleName>\r
- <ModuleType>PEIM</ModuleType>\r
- <GuidValue>bda39d3a-451b-4350-8266-81ab10fa0523</GuidValue>\r
- <Version>1.0</Version>\r
- <Abstract>Debug Library based on report status code library</Abstract>\r
- <Description>Debug Library for PEIMs and DXE drivers that send debug messages to ReportStatusCode</Description>\r
- <Copyright>Copyright (c) 2006, Intel Corporation.</Copyright>\r
- <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>\r
- <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052</Specification>\r
- </MsaHeader>\r
- <ModuleDefinitions>\r
- <SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>\r
- <BinaryModule>false</BinaryModule>\r
- <OutputFileBasename>PeiDxeDebugLibReportStatusCode</OutputFileBasename>\r
- </ModuleDefinitions>\r
- <LibraryClassDefinitions>\r
- <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER PEIM PEI_CORE UEFI_APPLICATION UEFI_DRIVER">\r
- <Keyword>DebugLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>BaseLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>BaseMemoryLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>ReportStatusCodeLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>PcdLib</Keyword>\r
- </LibraryClass>\r
- </LibraryClassDefinitions>\r
- <SourceFiles>\r
- <Filename>DebugLib.c</Filename>\r
- </SourceFiles>\r
- <PackageDependencies>\r
- <Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>\r
- </PackageDependencies>\r
- <Guids>\r
- <GuidCNames Usage="ALWAYS_CONSUMED">\r
- <GuidCName>gEfiStatusCodeDataTypeDebugGuid</GuidCName>\r
- </GuidCNames>\r
- </Guids>\r
- <Externs>\r
- <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>\r
- <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>\r
- </Externs>\r
- <PcdCoded>\r
- <PcdEntry PcdItemType="FIXED_AT_BUILD">\r
- <C_Name>PcdDebugPropertyMask</C_Name>\r
- <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
- <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>\r
- </PcdEntry>\r
- <PcdEntry PcdItemType="FIXED_AT_BUILD">\r
- <C_Name>PcdDebugClearMemoryValue</C_Name>\r
- <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
- <HelpText>The value used by DebugClearMemory () to fill a certain range
- of memory.</HelpText>\r
- </PcdEntry>\r
- <PcdEntry PcdItemType="DYNAMIC">\r
- <C_Name>PcdDebugPrintErrorLevel</C_Name>\r
- <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
- <HelpText>The bitmask of flags that specify the kind of debug message
- output when Debug Print is enabled.</HelpText>\r
- </PcdEntry>\r
- </PcdCoded>\r
-</ModuleSurfaceArea>
\ No newline at end of file
+++ /dev/null
-#/** @file\r
-# Report status code library\r
-#\r
-# ReportStatusCodeLib for PEIM which depends upon Pei Services table\r
-# Copyright (c) 2006 - 2007, Intel Corporation.\r
-#\r
-# All rights reserved. This program and the accompanying materials\r
-# are licensed and made available under the terms and conditions of the BSD License\r
-# which accompanies this distribution. The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php\r
-# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-#\r
-#\r
-#**/\r
-\r
-[Defines]\r
- INF_VERSION = 0x00010005\r
- BASE_NAME = PeiReportStatusCodeLib\r
- FILE_GUID = 8c690838-7a22-45c4-aa58-a33e3e515cd4\r
- MODULE_TYPE = PEIM\r
- VERSION_STRING = 1.0\r
- LIBRARY_CLASS = ReportStatusCodeLib|PEIM PEI_CORE\r
- EDK_RELEASE_VERSION = 0x00020000\r
- EFI_SPECIFICATION_VERSION = 0x00020000\r
-\r
-\r
-#\r
-# The following information is for reference only and not required by the build tools.\r
-#\r
-# VALID_ARCHITECTURES = IA32 X64 IPF EBC\r
-#\r
-\r
-[Sources.common]\r
- ReportStatusCodeLib.c\r
-\r
-\r
-[Packages]\r
- MdePkg/MdePkg.dec\r
- IntelFrameworkPkg/IntelFrameworkPkg.dec\r
-\r
-\r
-[LibraryClasses]\r
- PcdLib\r
- PeiServicesTablePointerLib\r
- BaseMemoryLib\r
- BaseLib\r
- DebugLib\r
-\r
-\r
-[Guids]\r
- gEfiStatusCodeSpecificDataGuid # ALWAYS_CONSUMED\r
- gEfiStatusCodeDataTypeDebugGuid # ALWAYS_CONSUMED\r
-\r
-\r
-[PcdsFixedAtBuild.common]\r
- PcdReportStatusCodePropertyMask|gEfiMdePkgTokenSpaceGuid\r
-\r
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>\r
-<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">\r
- <MsaHeader>\r
- <ModuleName>PeiReportStatusCodeLib</ModuleName>\r
- <ModuleType>PEIM</ModuleType>\r
- <GuidValue>8c690838-7a22-45c4-aa58-a33e3e515cd4</GuidValue>\r
- <Version>1.0</Version>\r
- <Abstract>Report status code library</Abstract>\r
- <Description>ReportStatusCodeLib for PEIM which depends upon Pei Services table</Description>\r
- <Copyright>Copyright (c) 2006 - 2007, Intel Corporation.</Copyright>\r
- <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>\r
- <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052</Specification>\r
- </MsaHeader>\r
- <ModuleDefinitions>\r
- <SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>\r
- <BinaryModule>false</BinaryModule>\r
- <OutputFileBasename>PeiReportStatusCodeLib</OutputFileBasename>\r
- </ModuleDefinitions>\r
- <LibraryClassDefinitions>\r
- <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="PEIM PEI_CORE">\r
- <Keyword>ReportStatusCodeLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>DebugLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>BaseLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>BaseMemoryLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>PeiServicesTablePointerLib</Keyword>\r
- </LibraryClass>\r
- <LibraryClass Usage="ALWAYS_CONSUMED">\r
- <Keyword>PcdLib</Keyword>\r
- </LibraryClass>\r
- </LibraryClassDefinitions>\r
- <SourceFiles>\r
- <Filename>ReportStatusCodeLib.c</Filename>\r
- </SourceFiles>\r
- <PackageDependencies>\r
- <Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>\r
- </PackageDependencies>\r
- <Guids>\r
- <GuidCNames Usage="ALWAYS_CONSUMED">\r
- <GuidCName>gEfiStatusCodeDataTypeDebugGuid</GuidCName>\r
- </GuidCNames>\r
- <GuidCNames Usage="ALWAYS_CONSUMED">\r
- <GuidCName>gEfiStatusCodeSpecificDataGuid</GuidCName>\r
- </GuidCNames>\r
- </Guids>\r
- <Externs>\r
- <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>\r
- <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>\r
- </Externs>\r
- <PcdCoded>\r
- <PcdEntry PcdItemType="FIXED_AT_BUILD">\r
- <C_Name>PcdReportStatusCodePropertyMask</C_Name>\r
- <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
- <HelpText>The bitmask of flags that specify the enable/disable of
- Progress Code, Error Code and Debug Code.</HelpText>\r
- </PcdEntry>\r
- </PcdCoded>\r
-</ModuleSurfaceArea>
\ No newline at end of file
+++ /dev/null
-/** @file\r
- Report Status Code Library for DXE Phase.\r
-\r
- Copyright (c) 2006, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-**/\r
-\r
-\r
-#include <FrameworkPei.h>\r
-\r
-#include <Guid/StatusCodeDataTypeId.h>\r
-\r
-#include <Library/ReportStatusCodeLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/BaseLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/PeiServicesTablePointerLib.h>\r
-#include <Library/PcdLib.h>\r
-\r
-//\r
-// Define the maximum extended data size that is supported in the PEI phase\r
-//\r
-#define MAX_EXTENDED_DATA_SIZE 0x200\r
-\r
-/**\r
- Internal worker function that reports a status code through the Status Code Protocol\r
-\r
- This function checks to see if a Status Code Protocol is present in the handle\r
- database. If a Status Code Protocol is not present, then EFI_UNSUPPORTED is\r
- returned. If a Status Code Protocol is present, then it is cached in gStatusCode,\r
- and the ReportStatusCode() service of the Status Code Protocol is called passing in\r
- Type, Value, Instance, CallerId, and Data. The result of this call is returned.\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this\r
- function. This is an optional parameter that may be\r
- NULL.\r
- @param Data Pointer to the extended data buffer. This is an\r
- optional parameter that may be NULL.\r
-\r
- @retval EFI_SUCCESS The status code was reported.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to report the status code.\r
- @retval EFI_UNSUPPORTED Status Code Protocol is not available.\r
-\r
-**/\r
-STATIC\r
-EFI_STATUS\r
-InternalReportStatusCode (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN UINT32 Instance,\r
- IN CONST EFI_GUID *CallerId OPTIONAL,\r
- IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
- )\r
-{\r
- EFI_PEI_SERVICES **PeiServices;\r
-\r
- PeiServices = GetPeiServicesTablePointer ();\r
- return (*PeiServices)->ReportStatusCode (\r
- PeiServices,\r
- Type,\r
- Value,\r
- Instance,\r
- (EFI_GUID *)CallerId,\r
- Data\r
- );\r
-}\r
-\r
-\r
-/**\r
- Converts a status code to an 8-bit POST code value.\r
-\r
- Converts the status code specified by CodeType and Value to an 8-bit POST code\r
- and returns the 8-bit POST code in PostCode. If CodeType is an\r
- EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode\r
- are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits\r
- 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.\r
-\r
- If PostCode is NULL, then ASSERT().\r
-\r
- @param CodeType The type of status code being converted.\r
- @param Value The status code value being converted.\r
- @param PostCode A pointer to the 8-bit POST code value to return.\r
-\r
- @retval TRUE The status code specified by CodeType and Value was converted\r
- to an 8-bit POST code and returned in PostCode.\r
- @retval FALSE The status code specified by CodeType and Value could not be\r
- converted to an 8-bit POST code value.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-CodeTypeToPostCode (\r
- IN EFI_STATUS_CODE_TYPE CodeType,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- OUT UINT8 *PostCode\r
- )\r
-{\r
- //\r
- // If PostCode is NULL, then ASSERT()\r
- //\r
- ASSERT (PostCode != NULL);\r
-\r
- //\r
- // Convert Value to an 8 bit post code\r
- //\r
- if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||\r
- ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) ) {\r
- *PostCode = (UINT8) ((((Value & EFI_STATUS_CODE_CLASS_MASK) >> 24) << 5) |\r
- (((Value & EFI_STATUS_CODE_SUBCLASS_MASK) >> 16) & 0x1f));\r
- return TRUE;\r
- }\r
- return FALSE;\r
-}\r
-\r
-\r
-/**\r
- Extracts ASSERT() information from a status code structure.\r
-\r
- Converts the status code specified by CodeType, Value, and Data to the ASSERT()\r
- arguments specified by Filename, Description, and LineNumber. If CodeType is\r
- an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and\r
- Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract\r
- Filename, Description, and LineNumber from the optional data area of the\r
- status code buffer specified by Data. The optional data area of Data contains\r
- a Null-terminated ASCII string for the FileName, followed by a Null-terminated\r
- ASCII string for the Description, followed by a 32-bit LineNumber. If the\r
- ASSERT() information could be extracted from Data, then return TRUE.\r
- Otherwise, FALSE is returned.\r
-\r
- If Data is NULL, then ASSERT().\r
- If Filename is NULL, then ASSERT().\r
- If Description is NULL, then ASSERT().\r
- If LineNumber is NULL, then ASSERT().\r
-\r
- @param CodeType The type of status code being converted.\r
- @param Value The status code value being converted.\r
- @param Data Pointer to status code data buffer.\r
- @param Filename Pointer to the source file name that generated the ASSERT().\r
- @param Description Pointer to the description of the ASSERT().\r
- @param LineNumber Pointer to source line number that generated the ASSERT().\r
-\r
- @retval TRUE The status code specified by CodeType, Value, and Data was\r
- converted ASSERT() arguments specified by Filename, Description,\r
- and LineNumber.\r
- @retval FALSE The status code specified by CodeType, Value, and Data could\r
- not be converted to ASSERT() arguments.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportStatusCodeExtractAssertInfo (\r
- IN EFI_STATUS_CODE_TYPE CodeType,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN CONST EFI_STATUS_CODE_DATA *Data,\r
- OUT CHAR8 **Filename,\r
- OUT CHAR8 **Description,\r
- OUT UINT32 *LineNumber\r
- )\r
-{\r
- EFI_DEBUG_ASSERT_DATA *AssertData;\r
-\r
- ASSERT (Data != NULL);\r
- ASSERT (Filename != NULL);\r
- ASSERT (Description != NULL);\r
- ASSERT (LineNumber != NULL);\r
-\r
- if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) &&\r
- ((CodeType & EFI_STATUS_CODE_SEVERITY_MASK) == EFI_ERROR_UNRECOVERED) &&\r
- ((Value & EFI_STATUS_CODE_OPERATION_MASK) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE)) {\r
- AssertData = (EFI_DEBUG_ASSERT_DATA *)(Data + 1);\r
- *Filename = (CHAR8 *)(AssertData + 1);\r
- *Description = *Filename + AsciiStrLen (*Filename) + 1;\r
- *LineNumber = AssertData->LineNumber;\r
- return TRUE;\r
- }\r
- return FALSE;\r
-}\r
-\r
-\r
-/**\r
- Extracts DEBUG() information from a status code structure.\r
-\r
- Converts the status code specified by Data to the DEBUG() arguments specified\r
- by ErrorLevel, Marker, and Format. If type GUID in Data is\r
- EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and\r
- Format from the optional data area of the status code buffer specified by Data.\r
- The optional data area of Data contains a 32-bit ErrorLevel followed by Marker\r
- which is 12 UINTN parameters, followed by a Null-terminated ASCII string for\r
- the Format. If the DEBUG() information could be extracted from Data, then\r
- return TRUE. Otherwise, FALSE is returned.\r
-\r
- If Data is NULL, then ASSERT().\r
- If ErrorLevel is NULL, then ASSERT().\r
- If Marker is NULL, then ASSERT().\r
- If Format is NULL, then ASSERT().\r
-\r
- @param Data Pointer to status code data buffer.\r
- @param ErrorLevel Pointer to error level mask for a debug message.\r
- @param Marker Pointer to the variable argument list associated with Format.\r
- @param Format Pointer to a Null-terminated ASCII format string of a\r
- debug message.\r
-\r
- @retval TRUE The status code specified by Data was converted DEBUG() arguments\r
- specified by ErrorLevel, Marker, and Format.\r
- @retval FALSE The status code specified by Data could not be converted to\r
- DEBUG() arguments.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportStatusCodeExtractDebugInfo (\r
- IN CONST EFI_STATUS_CODE_DATA *Data,\r
- OUT UINT32 *ErrorLevel,\r
- OUT VA_LIST *Marker,\r
- OUT CHAR8 **Format\r
- )\r
-{\r
- EFI_DEBUG_INFO *DebugInfo;\r
-\r
- ASSERT (Data != NULL);\r
- ASSERT (ErrorLevel != NULL);\r
- ASSERT (Marker != NULL);\r
- ASSERT (Format != NULL);\r
-\r
- //\r
- // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE\r
- //\r
- if (!CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid)) {\r
- return FALSE;\r
- }\r
-\r
- //\r
- // Retrieve the debug information from the status code record\r
- //\r
- DebugInfo = (EFI_DEBUG_INFO *)(Data + 1);\r
-\r
- *ErrorLevel = DebugInfo->ErrorLevel;\r
-\r
- //\r
- // The first 12 * UINTN bytes of the string are really an\r
- // argument stack to support varargs on the Format string.\r
- //\r
- *Marker = (VA_LIST) (DebugInfo + 1);\r
- *Format = (CHAR8 *)(((UINT64 *)*Marker) + 12);\r
-\r
- return TRUE;\r
-}\r
-\r
-\r
-/**\r
- Reports a status code.\r
-\r
- Reports the status code specified by the parameters Type and Value. Status\r
- code also require an instance, caller ID, and extended data. This function\r
- passed in a zero instance, NULL extended data, and a caller ID of\r
- gEfiCallerIdGuid, which is the GUID for the module.\r
-\r
- ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode()\r
- is called while processing another any other Report Status Code Library function,\r
- then ReportStatusCode() must return immediately.\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
-\r
- @retval EFI_SUCCESS The status code was reported.\r
- @retval EFI_DEVICE_ERROR There status code could not be reported due to a\r
- device error.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCode (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value\r
- )\r
-{\r
- return InternalReportStatusCode (Type, Value, 0, &gEfiCallerIdGuid, NULL);\r
-}\r
-\r
-\r
-/**\r
- Reports a status code with a Device Path Protocol as the extended data.\r
-\r
- Allocates and fills in the extended data section of a status code with the\r
- Device Path Protocol specified by DevicePath. This function is responsible\r
- for allocating a buffer large enough for the standard header and the device\r
- path. The standard header is filled in with a GUID of\r
- gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero\r
- instance and a caller ID of gEfiCallerIdGuid.\r
-\r
- ReportStatusCodeWithDevicePath()must actively prevent recursion. If\r
- ReportStatusCodeWithDevicePath() is called while processing another any other\r
- Report Status Code Library function, then ReportStatusCodeWithDevicePath()\r
- must return EFI_DEVICE_ERROR immediately.\r
-\r
- If DevicePath is NULL, then ASSERT().\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param DevicePath Pointer to the Device Path Protocol to be reported.\r
-\r
- @retval EFI_SUCCESS The status code was reported with the extended\r
- data specified by DevicePath.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the\r
- extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCodeWithDevicePath (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
- )\r
-{\r
- ASSERT (DevicePath != NULL);\r
- return EFI_UNSUPPORTED;\r
-}\r
-\r
-\r
-/**\r
- Reports a status code with an extended data buffer.\r
-\r
- Allocates and fills in the extended data section of a status code with the\r
- extended data specified by ExtendedData and ExtendedDataSize. ExtendedData\r
- is assumed to be one of the data structures specified in Related Definitions.\r
- These data structure do not have the standard header, so this function is\r
- responsible for allocating a buffer large enough for the standard header and\r
- the extended data passed into this function. The standard header is filled\r
- in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported\r
- with a zero instance and a caller ID of gEfiCallerIdGuid.\r
-\r
- ReportStatusCodeWithExtendedData()must actively prevent recursion. If\r
- ReportStatusCodeWithExtendedData() is called while processing another any other\r
- Report Status Code Library function, then ReportStatusCodeWithExtendedData()\r
- must return EFI_DEVICE_ERROR immediately.\r
-\r
- If ExtendedData is NULL, then ASSERT().\r
- If ExtendedDataSize is 0, then ASSERT().\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param ExtendedData Pointer to the extended data buffer to be reported.\r
- @param ExtendedDataSize The size, in bytes, of the extended data buffer to\r
- be reported.\r
-\r
- @retval EFI_SUCCESS The status code was reported with the extended\r
- data specified by ExtendedData and ExtendedDataSize.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the\r
- extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCodeWithExtendedData (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN CONST VOID *ExtendedData,\r
- IN UINTN ExtendedDataSize\r
- )\r
-{\r
- ASSERT (ExtendedData != NULL);\r
- ASSERT (ExtendedDataSize != 0);\r
- return ReportStatusCodeEx (\r
- Type,\r
- Value,\r
- 0,\r
- NULL,\r
- NULL,\r
- ExtendedData,\r
- ExtendedDataSize\r
- );\r
-}\r
-\r
-\r
-/**\r
- Reports a status code with full parameters.\r
-\r
- The function reports a status code. If ExtendedData is NULL and ExtendedDataSize\r
- is 0, then an extended data buffer is not reported. If ExtendedData is not\r
- NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.\r
- ExtendedData is assumed not have the standard status code header, so this function\r
- is responsible for allocating a buffer large enough for the standard header and\r
- the extended data passed into this function. The standard header is filled in\r
- with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a\r
- GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with\r
- an instance specified by Instance and a caller ID specified by CallerId. If\r
- CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
-\r
- ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx()\r
- is called while processing another any other Report Status Code Library function,\r
- then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.\r
-\r
- If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
- If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
-\r
- @param Type Status code type.\r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this\r
- function. If this parameter is NULL, then a caller\r
- ID of gEfiCallerIdGuid is used.\r
- @param ExtendedDataGuid Pointer to the GUID for the extended data buffer.\r
- If this parameter is NULL, then a the status code\r
- standard header is filled in with\r
- gEfiStatusCodeSpecificDataGuid.\r
- @param ExtendedData Pointer to the extended data buffer. This is an\r
- optional parameter that may be NULL.\r
- @param ExtendedDataSize The size, in bytes, of the extended data buffer.\r
-\r
- @retval EFI_SUCCESS The status code was reported.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate\r
- the extended data section if it was specified.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-ReportStatusCodeEx (\r
- IN EFI_STATUS_CODE_TYPE Type,\r
- IN EFI_STATUS_CODE_VALUE Value,\r
- IN UINT32 Instance,\r
- IN CONST EFI_GUID *CallerId OPTIONAL,\r
- IN CONST EFI_GUID *ExtendedDataGuid OPTIONAL,\r
- IN CONST VOID *ExtendedData OPTIONAL,\r
- IN UINTN ExtendedDataSize\r
- )\r
-{\r
- EFI_STATUS_CODE_DATA *StatusCodeData;\r
- UINT64 Buffer[MAX_EXTENDED_DATA_SIZE / sizeof (UINT64)];\r
-\r
- ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));\r
- ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));\r
-\r
- if (ExtendedDataSize > (MAX_EXTENDED_DATA_SIZE - sizeof (EFI_STATUS_CODE_DATA))) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
- StatusCodeData = (EFI_STATUS_CODE_DATA *)Buffer;\r
- StatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);\r
- StatusCodeData->Size = (UINT16)ExtendedDataSize;\r
- if (ExtendedDataGuid == NULL) {\r
- ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;\r
- }\r
- CopyGuid (&StatusCodeData->Type, ExtendedDataGuid);\r
- CopyMem (StatusCodeData + 1, ExtendedData, ExtendedDataSize);\r
- if (CallerId == NULL) {\r
- CallerId = &gEfiCallerIdGuid;\r
- }\r
- return InternalReportStatusCode (Type, Value, Instance, CallerId, StatusCodeData);\r
-}\r
-\r
-\r
-/**\r
- Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled\r
-\r
- This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED\r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is set.\r
- @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportProgressCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);\r
-}\r
-\r
-\r
-/**\r
- Returns TRUE if status codes of type EFI_ERROR_CODE are enabled\r
-\r
- This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED\r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is set.\r
- @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportErrorCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);\r
-}\r
-\r
-\r
-/**\r
- Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled\r
-\r
- This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED\r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
-\r
- @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is set.\r
- @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
- PcdReportStatusCodeProperyMask is clear.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-ReportDebugCodeEnabled (\r
- VOID\r
- )\r
-{\r
- return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
-}\r
projects / mirror_edk2.git / commitdiff