/** @file\r
API implementation for instance of Report Status Code Library.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
**/\r
\r
-#include "ReportStatusCodeLibInternal.h"\r
+#include <Library/ReportStatusCodeLib.h>\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/DevicePathLib.h>\r
+#include <Library/UefiRuntimeLib.h>\r
+\r
+#include <Protocol/StatusCode.h>\r
+\r
+#include <Guid/StatusCodeDataTypeId.h>\r
+#include <Guid/StatusCodeDataTypeDebug.h>\r
+#include <Guid/EventGroup.h>\r
+\r
+EFI_STATUS_CODE_PROTOCOL *mReportStatusCodeLibStatusCodeProtocol = NULL;\r
+EFI_EVENT mReportStatusCodeLibVirtualAddressChangeEvent;\r
+\r
+/**\r
+ Locate the report status code service.\r
+\r
+ Retrieve ReportStatusCode() API of Report Status Code Protocol.\r
+\r
+**/\r
+VOID\r
+InternalGetReportStatusCode (\r
+ VOID\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ if (mReportStatusCodeLibStatusCodeProtocol != NULL) {\r
+ return;\r
+ }\r
+ \r
+ if (EfiAtRuntime ()) {\r
+ return;\r
+ }\r
+ \r
+ //\r
+ // Check gBS just in case ReportStatusCode is called before gBS is initialized.\r
+ //\r
+ if (gBS != NULL && gBS->LocateProtocol != NULL) {\r
+ Status = gBS->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid, NULL, (VOID**) &mReportStatusCodeLibStatusCodeProtocol);\r
+ if (EFI_ERROR (Status)) {\r
+ mReportStatusCodeLibStatusCodeProtocol = NULL;\r
+ }\r
+ }\r
+}\r
+\r
+/**\r
+ Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.\r
+\r
+ @param Event Event whose notification function is being invoked.\r
+ @param Context Pointer to the notification function's context\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ReportStatusCodeLibVirtualAddressChange (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
+{\r
+ if (mReportStatusCodeLibStatusCodeProtocol == NULL) {\r
+ return;\r
+ }\r
+ EfiConvertPointer (0, (VOID **) &mReportStatusCodeLibStatusCodeProtocol);\r
+}\r
+\r
+/**\r
+ The constructor function of Runtime DXE Report Status Code Lib.\r
+\r
+ This function allocates memory for extended status code data, caches\r
+ the report status code service, and registers events.\r
+\r
+ @param ImageHandle The firmware allocated handle for the EFI image.\r
+ @param SystemTable A pointer to the EFI System Table.\r
+ \r
+ @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ReportStatusCodeLibConstructor (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ //\r
+ // Cache the report status code service\r
+ // \r
+ InternalGetReportStatusCode ();\r
+\r
+ //\r
+ // Register notify function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE\r
+ // \r
+ Status = gBS->CreateEventEx (\r
+ EVT_NOTIFY_SIGNAL,\r
+ TPL_NOTIFY,\r
+ ReportStatusCodeLibVirtualAddressChange,\r
+ NULL,\r
+ &gEfiEventVirtualAddressChangeGuid,\r
+ &mReportStatusCodeLibVirtualAddressChangeEvent\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ The destructor function of Runtime DXE Report Status Code Lib.\r
+ \r
+ The destructor function frees memory allocated by constructor, and closes related events.\r
+ It will ASSERT() if that related operation fails and it will always return EFI_SUCCESS. \r
+\r
+ @param ImageHandle The firmware allocated handle for the EFI image.\r
+ @param SystemTable A pointer to the EFI System Table.\r
+ \r
+ @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ReportStatusCodeLibDestructor (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ ASSERT (gBS != NULL);\r
+ Status = gBS->CloseEvent (mReportStatusCodeLibVirtualAddressChangeEvent);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Internal worker function that reports a status code through the Report Status Code Protocol.\r
+\r
+ If status code service is not cached, then this function checks if Report Status Code\r
+ Protocol is available in system. If Report Status Code Protocol is not available, then\r
+ EFI_UNSUPPORTED is returned. If Report Status Code Protocol is present, then it is\r
+ cached in mReportStatusCodeLibStatusCodeProtocol. Finally this function reports status\r
+ code through the Report Status Code Protocol.\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_UNSUPPORTED Report Status Code Protocol is not available.\r
+ @retval EFI_UNSUPPORTED Status code type is not supported.\r
+\r
+**/\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
+ if ((ReportProgressCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||\r
+ (ReportErrorCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) ||\r
+ (ReportDebugCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE)) {\r
+ //\r
+ // If mReportStatusCodeLibStatusCodeProtocol is NULL, then check if Report Status Code Protocol is available in system.\r
+ //\r
+ InternalGetReportStatusCode ();\r
+ if (mReportStatusCodeLibStatusCodeProtocol == NULL) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ //\r
+ // A Report Status Code Protocol is present in system, so pass in all the parameters to the service.\r
+ //\r
+ return mReportStatusCodeLibStatusCodeProtocol->ReportStatusCode (Type, Value, Instance, (EFI_GUID *)CallerId, Data);\r
+ }\r
+ \r
+ return EFI_UNSUPPORTED;\r
+}\r
+\r
\r
/**\r
Converts a status code to an 8-bit POST code value.\r
)\r
{\r
EFI_STATUS Status;\r
+ EFI_STATUS_CODE_DATA *StatusCodeData;\r
+ UINT8 StatusCodeBuffer[EFI_STATUS_CODE_DATA_MAX_SIZE];\r
\r
ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));\r
ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));\r
\r
- if (ExtendedDataSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
- return EFI_OUT_OF_RESOURCES;\r
+ if (EfiAtRuntime ()) {\r
+ if (sizeof (EFI_STATUS_CODE_DATA) + ExtendedDataSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ StatusCodeData = (EFI_STATUS_CODE_DATA *)StatusCodeBuffer;\r
+ } else {\r
+ if (gBS == NULL || gBS->AllocatePool == NULL || gBS->FreePool == 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
//\r
// Fill in the extended data header\r
//\r
- mStatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);\r
- mStatusCodeData->Size = (UINT16)ExtendedDataSize;\r
+ StatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);\r
+ StatusCodeData->Size = (UINT16)ExtendedDataSize;\r
if (ExtendedDataGuid == NULL) {\r
ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;\r
}\r
- CopyGuid (&mStatusCodeData->Type, ExtendedDataGuid);\r
+ CopyGuid (&StatusCodeData->Type, ExtendedDataGuid);\r
\r
//\r
// Fill in the extended data buffer\r
//\r
if (ExtendedData != NULL) {\r
- CopyMem (mStatusCodeData + 1, ExtendedData, ExtendedDataSize);\r
+ CopyMem (StatusCodeData + 1, ExtendedData, ExtendedDataSize);\r
}\r
\r
//\r
if (CallerId == NULL) {\r
CallerId = &gEfiCallerIdGuid;\r
}\r
- Status = InternalReportStatusCode (Type, Value, Instance, CallerId, mStatusCodeData);\r
+ Status = InternalReportStatusCode (Type, Value, Instance, CallerId, StatusCodeData);\r
+\r
+ //\r
+ // Free the allocated buffer\r
+ //\r
+ if (!EfiAtRuntime()) {\r
+ gBS->FreePool (StatusCodeData);\r
+ }\r
\r
return Status;\r
}\r
projects / mirror_edk2.git / blobdiff