MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Core / Pei / StatusCode / StatusCode.c

/** @file\r
  Pei Core Status Code Support\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "PeiMain.h"\r
\r
/**\r
\r
  Core version of the Status Code reporter\r
\r
\r
  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param CodeType        Type of Status Code.\r
  @param Value           Value to output for Status Code.\r
  @param Instance        Instance Number of this status code.\r
  @param CallerId        ID of the caller of this status code.\r
  @param Data            Optional data associated with this status code.\r
\r
  @retval EFI_SUCCESS             if status code is successfully reported\r
  @retval EFI_NOT_AVAILABLE_YET   if StatusCodePpi has not been installed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiReportStatusCode (\r
  IN CONST EFI_PEI_SERVICES         **PeiServices,\r
  IN EFI_STATUS_CODE_TYPE           CodeType,\r
  IN EFI_STATUS_CODE_VALUE          Value,\r
  IN UINT32                         Instance,\r
  IN CONST EFI_GUID                 *CallerId,\r
  IN CONST EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_PEI_PROGRESS_CODE_PPI *StatusCodePpi;\r
\r
  //\r
  // Locate StatusCode Ppi.\r
  //\r
  Status = PeiServicesLocatePpi (\r
             &gEfiPeiStatusCodePpiGuid,\r
             0,\r
             NULL,\r
             (VOID **)&StatusCodePpi\r
             );\r
\r
  if (!EFI_ERROR (Status)) {\r
    Status = StatusCodePpi->ReportStatusCode (\r
                            PeiServices,\r
                            CodeType,\r
                            Value,\r
                            Instance,\r
                            CallerId,\r
                            Data\r
                            );\r
\r
   return Status;\r
  }\r
\r
  return  EFI_NOT_AVAILABLE_YET;\r
}\r
\r
\r
\r