IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / SmmRuntimeDxeReportStatusCodeLibFramework / ReportStatusCodeLibInternal.h

/** @file\r
  Internal Header file of Report Status Code Library for RUNTIME\r
  DXE Phase.\r
\r
  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#ifndef __REPORT_STATUS_CODE_LIB_INTERNAL__H__\r
#define __REPORT_STATUS_CODE_LIB_INTERNAL__H__\r
\r
#include <FrameworkSmm.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/PcdLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
#include <Guid/StatusCodeDataTypeId.h>\r
#include <Guid/StatusCodeDataTypeDebug.h>\r
#include <Guid/EventGroup.h>\r
\r
#include <Protocol/SmmStatusCode.h>\r
#include <Protocol/StatusCode.h>\r
#include <Protocol/SmmBase.h>\r
\r
\r
extern EFI_STATUS_CODE_DATA    *mStatusCodeData;\r
\r
/**\r
  Internal worker function that reports a status code through the status code service.\r
\r
  If status code service is not cached, then this function checks if status code service is\r
  available in system.  If status code service is not available, then EFI_UNSUPPORTED is\r
  returned.  If status code service is present, then it is cached in mReportStatusCode.\r
  Finally this function reports status code through the status code service.\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   Status code service 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
#endif\r
\r