Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Include / Pei / PeiDebug.h

/*++\r
\r
Copyright (c) 2007, 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
  PeiDebug.h\r
\r
Abstract:\r
\r
  PEI Debug macros. The work needs to be done in library. The Debug\r
  macros them selves are standard for all files, including the core.\r
  \r
  There needs to be code linked in that produces the following macros:\r
  \r
  PeiDebugAssert(file, linenumber, assertion string) - worker function for \r
      ASSERT. filename and line number of where this ASSERT() is located\r
      is passed in along with the stringized version of the assertion.\r
  \r
  PeiDebugPrint - Worker function for debug print\r
\r
  _DEBUG_SET_MEM(address, length, value) - Set memory at address to value\r
    for legnth bytes. This macro is used to initialzed uninitialized memory\r
    or memory that is free'ed, so it will not be used by mistake. \r
\r
--*/\r
\r
#ifndef _PEIDEBUG_H_\r
#define _PEIDEBUG_H_\r
\r
#ifdef EFI_DEBUG\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
  VOID\r
  PeiDebugPrint (\r
    IN CONST EFI_PEI_SERVICES   **PeiServices,\r
    IN UINTN              ErrorLevel,\r
    IN CHAR8              *Format,\r
    ...\r
    );\r
\r
  #define _PEI_DEBUG_ASSERT(PeiST, assertion)  \\r
            PeiDebugAssert (PeiST, __FILE__, __LINE__, #assertion)\r
\r
  #define _PEI_DEBUG(PeiST, arg) PeiDebugPrint (PeiST, arg)\r
\r
  //\r
  // Define ASSERT() macro, if assertion is FALSE trigger the ASSERT\r
  //\r
  #define PEI_ASSERT(PeiST, assertion)   if(!(assertion))  \\r
                                            _PEI_DEBUG_ASSERT(PeiST, assertion)\r
    \r
  #define PEI_ASSERT_LOCKED(PeiST, l)    if(!(l)->Lock) _PEI_DEBUG_ASSERT(PeiST, l not locked)\r
\r
  //\r
  // DEBUG((DebugLevel, "format string", ...)) - if DebugLevel is active do \r
  //   the a debug print.\r
  //\r
  \r
  #define PEI_DEBUG(arg)        PeiDebugPrint arg\r
\r
  #define PEI_DEBUG_CODE(code)  code\r
\r
  #define PEI_CR(Record, TYPE, Field, Signature)   \\r
            _CR(Record, TYPE, Field)                           \r
\r
\r
  #define _PEI_DEBUG_SET_MEM(address, length, data) SetMem(address, length, data)\r
\r
#else\r
  #define PEI_ASSERT(PeiST, a)               \r
  #define PEI_ASSERT_LOCKED(PeiST, l)    \r
  #define PEI_DEBUG(arg) \r
  #define PEI_DEBUG_CODE(code)  \r
  #define PEI_CR(Record, TYPE, Field, Signature)   \\r
            _CR(Record, TYPE, Field)                           \r
  #define _PEI_DEBUG_SET_MEM(address, length, data) \r
#endif\r
\r
#define ASSERT_PEI_ERROR(PeiST, status)  PEI_ASSERT(PeiST, !EFI_ERROR(status))\r
\r
#ifdef EFI_DEBUG_CLEAR_MEMORY\r
  #define PEI_DEBUG_SET_MEMORY(address,length)  \\r
            _PEI_DEBUG_SET_MEM(address, length, EFI_BAD_POINTER_AS_BYTE)\r
#else\r
  #define PEI_DEBUG_SET_MEMORY(address,length)\r
#endif\r
\r
\r
#endif\r