Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / Pei / PeiLib / Debug.c

/*++\r
\r
Copyright (c) 2004 - 2005, 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
  Debug.c\r
\r
Abstract:\r
\r
  Support for Debug primatives. \r
\r
--*/\r
\r
#include "Tiano.h"\r
#include "Pei.h"\r
#include "EfiPrintLib.h"\r
#include "EfiStatusCode.h"\r
#include "EfiCommonLib.h"\r
#include EFI_GUID_DEFINITION (StatusCodeCallerId)\r
#include EFI_GUID_DEFINITION (StatusCodeDataTypeId)\r
\r
VOID\r
PeiDebugAssert (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN CHAR8              *FileName,\r
  IN INTN               LineNumber,\r
  IN CHAR8              *Description\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Worker function for ASSERT(). If Error Logging hub is loaded log ASSERT\r
  information. If Error Logging hub is not loaded DEADLOOP ().\r
  \r
Arguments:\r
\r
  PeiServices - The PEI core services table.\r
\r
  FileName    - File name of failing routine.\r
\r
  LineNumber  - Line number of failing ASSERT().\r
\r
  Description - Description, usually the assertion,\r
  \r
Returns:\r
  \r
  None\r
\r
--*/\r
{\r
  UINT64  Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE];\r
\r
  EfiDebugAssertWorker (FileName, LineNumber, Description, sizeof (Buffer), Buffer);\r
\r
  //\r
  // We choose NOT to use PEI_REPORT_STATUS_CODE here, because when debug is enable,\r
  // we want get enough information if assert.\r
  //\r
  (**PeiServices).PeiReportStatusCode (\r
                    (EFI_PEI_SERVICES**)PeiServices,\r
                    (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),\r
                    (EFI_SOFTWARE_PEI_MODULE | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),\r
                    0,\r
                    &gEfiCallerIdGuid,\r
                    (EFI_STATUS_CODE_DATA *) Buffer\r
                    );\r
\r
  EFI_DEADLOOP ();\r
}\r
\r
\r
VOID\r
PeiDebugPrint (\r
  IN CONST EFI_PEI_SERVICES   **PeiServices,\r
  IN  UINTN             ErrorLevel,\r
  IN  CHAR8             *Format,\r
  ...\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Worker function for DEBUG(). If Error Logging hub is loaded log ASSERT\r
  information. If Error Logging hub is not loaded do nothing.\r
  \r
Arguments:\r
\r
  PeiServices - The PEI core services table.\r
\r
  ErrorLevel - If error level is set do the debug print.\r
\r
  Format     - String to use for the print, followed by Print arguments.\r
\r
  ...        - Print arguments\r
  \r
Returns:\r
  \r
  None\r
\r
--*/\r
{\r
  VA_LIST Marker;\r
  UINT64  Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE];\r
\r
  VA_START (Marker, Format);\r
  EfiDebugVPrintWorker (ErrorLevel, Format, Marker, sizeof (Buffer), Buffer);\r
\r
  //\r
  // We choose NOT to use PEI_REPORT_STATUS_CODE here, because when debug is enable,\r
  // we want get enough information if assert.\r
  //\r
  (**PeiServices).PeiReportStatusCode (\r
                    (EFI_PEI_SERVICES**)PeiServices,\r
                    EFI_DEBUG_CODE,\r
                    (EFI_SOFTWARE_PEI_MODULE | EFI_DC_UNSPECIFIED),\r
                    0,\r
                    &gEfiCallerIdGuid,\r
                    (EFI_STATUS_CODE_DATA *) Buffer\r
                    );\r
\r
  return ;\r
}\r