Sync all bug fixes between EDK1.04 and EDK1.06 into EdkCompatibilityPkg.

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / Dxe / EfiDriverLib / ReportStatusCode.c

/*++\r
\r
Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  ReportStatusCode.c\r
\r
Abstract:\r
\r
--*/\r
\r
#include "Tiano.h"\r
#include "EfiDriverLib.h"\r
#include "PeiHob.h"\r
#include EFI_PROTOCOL_DEFINITION (DevicePath)\r
#include EFI_GUID_DEFINITION (Hob)\r
#include EFI_GUID_DEFINITION (StatusCodeDataTypeId)\r
#include EFI_ARCH_PROTOCOL_DEFINITION (StatusCode)\r
\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
\r
EFI_REPORT_STATUS_CODE gReportStatusCode = NULL;\r
\r
VOID\r
EFIAPI\r
OnStatusCodeInstall (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_STATUS_CODE_PROTOCOL  *StatusCode;\r
\r
  Status = gBS->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid, NULL, (VOID **) &StatusCode);\r
  if (!EFI_ERROR (Status)) {\r
    gReportStatusCode = StatusCode->ReportStatusCode;\r
  }\r
}\r
\r
EFI_STATUS\r
GetPeiProtocol (\r
  IN EFI_GUID  *ProtocolGuid,\r
  IN VOID      **Interface\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Searches for a Protocol Interface passed from PEI through a HOB\r
\r
Arguments:\r
\r
  ProtocolGuid - The Protocol GUID to search for in the HOB List\r
  Interface    - A pointer to the interface for the Protocol GUID\r
\r
Returns:\r
\r
  EFI_SUCCESS   - The Protocol GUID was found and its interface is returned in Interface\r
  EFI_NOT_FOUND - The Protocol GUID was not found in the HOB List\r
\r
--*/\r
{\r
  EFI_STATUS            Status;\r
  EFI_PEI_HOB_POINTERS  GuidHob;\r
\r
  //\r
  // Get Hob list\r
  //\r
  Status = EfiLibGetSystemConfigurationTable (&gEfiHobListGuid, (VOID **)  &GuidHob.Raw);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  for (Status = EFI_NOT_FOUND; EFI_ERROR (Status);) {\r
    if (END_OF_HOB_LIST (GuidHob)) {\r
      Status = EFI_NOT_FOUND;\r
      break;\r
    }\r
\r
    if (GET_HOB_TYPE (GuidHob) == EFI_HOB_TYPE_GUID_EXTENSION) {\r
      if (EfiCompareGuid (ProtocolGuid, &GuidHob.Guid->Name)) {\r
        Status     = EFI_SUCCESS;\r
        *Interface = (VOID *) *(UINTN *) ((UINT8 *) (&GuidHob.Guid->Name) + sizeof (EFI_GUID));\r
      }\r
    }\r
\r
    GuidHob.Raw = GET_NEXT_HOB (GuidHob);\r
  }\r
\r
  return Status;\r
}\r
\r
#endif\r
\r
EFI_STATUS\r
EfiLibReportStatusCode (\r
  IN EFI_STATUS_CODE_TYPE     Type,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 *CallerId OPTIONAL,\r
  IN EFI_STATUS_CODE_DATA     *Data     OPTIONAL  \r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Report device path through status code.\r
\r
Arguments:\r
\r
  Type        - Code type\r
  Value       - Code value\r
  Instance    - Instance number\r
  CallerId    - Caller name\r
  DevicePath  - Device path that to be reported\r
\r
Returns:\r
\r
  Status code.\r
\r
  EFI_OUT_OF_RESOURCES - No enough buffer could be allocated\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
  if (gReportStatusCode == NULL) {\r
    //\r
    // Because we've installed the protocol notification on EfiStatusCodeRuntimeProtocol,\r
    //   running here indicates that the StatusCode driver has not started yet.\r
    //\r
    if (gBS == NULL) {\r
      //\r
      // Running here only when StatusCode driver never starts.\r
      //\r
      return EFI_UNSUPPORTED;\r
    }\r
\r
    //\r
    // Try to get the PEI version of ReportStatusCode.\r
    //      \r
    Status = GetPeiProtocol (&gEfiStatusCodeRuntimeProtocolGuid, (VOID **) &gReportStatusCode);\r
    if (EFI_ERROR (Status)) {\r
      return EFI_UNSUPPORTED;\r
    }\r
  }\r
  Status = gReportStatusCode (Type, Value, Instance, CallerId, Data);\r
#else\r
  if (gRT == NULL) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  //\r
  // Check whether EFI_RUNTIME_SERVICES has Tiano Extension\r
  //\r
  Status = EFI_UNSUPPORTED;\r
  if (gRT->Hdr.Revision     == EFI_SPECIFICATION_VERSION     &&\r
      gRT->Hdr.HeaderSize   == sizeof (EFI_RUNTIME_SERVICES) &&\r
      gRT->ReportStatusCode != NULL) {\r
    Status = gRT->ReportStatusCode (Type, Value, Instance, CallerId, Data);\r
  }\r
#endif\r
  return Status;\r
}\r
\r
EFI_STATUS\r
ReportStatusCodeWithDevicePath (\r
  IN EFI_STATUS_CODE_TYPE     Type,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 * CallerId OPTIONAL,\r
  IN EFI_DEVICE_PATH_PROTOCOL * DevicePath\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Report device path through status code.\r
\r
Arguments:\r
\r
  Type        - Code type\r
  Value       - Code value\r
  Instance    - Instance number\r
  CallerId    - Caller name\r
  DevicePath  - Device path that to be reported\r
\r
Returns:\r
\r
  Status code.\r
\r
  EFI_OUT_OF_RESOURCES - No enough buffer could be allocated\r
\r
--*/\r
{\r
  UINT16                    Size;\r
  UINT16                    DevicePathSize;\r
  EFI_STATUS_CODE_DATA      *ExtendedData;\r
  EFI_DEVICE_PATH_PROTOCOL  *ExtendedDevicePath;\r
  EFI_STATUS                Status;\r
\r
  DevicePathSize  = (UINT16) EfiDevicePathSize (DevicePath);\r
  Size            = (UINT16) (DevicePathSize + sizeof (EFI_STATUS_CODE_DATA));\r
  ExtendedData    = (EFI_STATUS_CODE_DATA *) EfiLibAllocatePool (Size);\r
  if (ExtendedData == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  ExtendedDevicePath = EfiConstructStatusCodeData (Size, &gEfiStatusCodeSpecificDataGuid, ExtendedData);\r
  EfiCopyMem (ExtendedDevicePath, DevicePath, DevicePathSize);\r
\r
  Status = EfiLibReportStatusCode (Type, Value, Instance, CallerId, (EFI_STATUS_CODE_DATA *) ExtendedData);\r
\r
  gBS->FreePool (ExtendedData);\r
  return Status;\r
}\r